Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update AMDS Firmware page for new updates made in AMDC v1.3 #99

Merged
merged 11 commits into from
Sep 13, 2024

Conversation

codecubepi
Copy link
Contributor

@codecubepi codecubepi commented May 24, 2024

Resolves #98

I updated any pages about the AMDS that had outdated information, whether it be changes in AMDC Firmware v1.3, or older.

@codecubepi codecubepi self-assigned this May 24, 2024
@codecubepi codecubepi added the documentation Improvements or additions to documentation label May 24, 2024
@codecubepi codecubepi marked this pull request as ready for review May 30, 2024 01:02
Copy link
Contributor

@npetersen2 npetersen2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @codecubepi ! Looking nice! a few comments:

source/accessories/amds/firmware/index.md Outdated Show resolved Hide resolved
source/accessories/amds/firmware/index.md Outdated Show resolved Hide resolved
source/accessories/amds/firmware/index.md Outdated Show resolved Hide resolved
source/accessories/amds/firmware/index.md Outdated Show resolved Hide resolved
source/accessories/amds/mainboard/index.md Outdated Show resolved Hide resolved
source/getting-started/user-guide/amds-interface.md Outdated Show resolved Hide resolved
source/getting-started/user-guide/amds-interface.md Outdated Show resolved Hide resolved
source/getting-started/user-guide/amds-interface.md Outdated Show resolved Hide resolved
source/getting-started/user-guide/amds-interface.md Outdated Show resolved Hide resolved
source/getting-started/user-guide/amds-interface.md Outdated Show resolved Hide resolved
@codecubepi codecubepi requested a review from npetersen2 June 1, 2024 00:45
@codecubepi
Copy link
Contributor Author

Feedback has been addressed (except for the one above), and I've confirmed that everything looks good by building locally.

@codecubepi codecubepi requested a review from npetersen2 June 2, 2024 18:54
@codecubepi
Copy link
Contributor Author

Alright, I added the additional descriptions you requested. Again, I tested to make sure my fancy color-coded bullets build correctly. Even if everything looks good now (ie you approve), we should probably hold off on merging this until v1.3 is fully de-bugged and released.

npetersen2
npetersen2 previously approved these changes Jun 3, 2024
Copy link
Contributor

@npetersen2 npetersen2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, I approve.

I agree, let's wait to hit the merge button until v1.3 is released, i.e., Severson-Group/AMDC-Firmware#372

@codecubepi
Copy link
Contributor Author

Switching back to Draft status so that I remember to update the AMDS docs with the new debug counters:

@npetersen2 npetersen2 self-requested a review August 20, 2024 17:10
@codecubepi codecubepi marked this pull request as ready for review August 20, 2024 19:03
@codecubepi
Copy link
Contributor Author

@npetersen2 This is now also ready for review, as I've added the new text and images pertaining to the debug counters to the AMDS User Guide page. This should be merged after #108.

@codecubepi codecubepi requested a review from npetersen2 August 27, 2024 21:02
@codecubepi
Copy link
Contributor Author

@npetersen2 this PR is still waiting for a review. It looks like we have a merge conflict on the User Guide page, since Ryan merged his math profiling docs the other day. It is an easy conflict that I'll fix via the web editor when it's time to merge.

npetersen2
npetersen2 previously approved these changes Sep 13, 2024
Copy link
Contributor

@npetersen2 npetersen2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good @codecubepi

My only comment would be to regenerate the plot with increased font size to ensure it will be legible on the website. But, it is probably fine... :)

@codecubepi
Copy link
Contributor Author

I built the page and think the plot text is pretty legible... then again I am always teased for liking my text small 🤷‍♂️

@codecubepi codecubepi merged commit 3c65c76 into main Sep 13, 2024
@codecubepi codecubepi deleted the user/codecubepi/amds-firmware-update branch September 13, 2024 20:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update docs for new AMDS Interface
2 participants