Skip to content

Conversation

@sdelliot
Copy link
Collaborator

@sdelliot sdelliot commented Sep 23, 2025

Reorganize Documentation

Description

This PR reorganizes the FIREWHEEL documentation to clean up the documentation side bar and ensure all documentation is located with related documentation. This will make extending the documentation significantly easier in the future and enable easier location of needed docs.

Type of Change

Please select the type of change your pull request introduces:

  • Bugfix
  • New feature
  • Documentation update
  • Other (please describe):

Checklist

  • This PR conforms to the process detailed in the Contributing Guide.
  • I have included no proprietary/sensitive information in my code.
  • I have performed a self-review of my code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • I have tested my code.

Additional Notes

Documentation was primarily moved and the content was not significantly changed. Mostly grammar/spelling/clarity was addressed.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Sep 23, 2025
@sdelliot sdelliot requested a review from a team September 23, 2025 11:41
Copy link

@pleoxconfusa pleoxconfusa left a comment

Choose a reason for hiding this comment

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

LGTM

mitchnegus
mitchnegus previously approved these changes Sep 23, 2025
Co-authored-by: Mitch Negus <21086604+mitchnegus@users.noreply.github.com>
Signed-off-by: Steven Elliott <6461548+sdelliot@users.noreply.github.com>
@sdelliot sdelliot requested a review from mitchnegus September 23, 2025 20:54
@mitchnegus
Copy link
Member

@sdelliot Do the changes you added in c4a1d72 actually have impacts on workflow/tagging, or is that just metadata?

@sdelliot
Copy link
Collaborator Author

@sdelliot Do the changes you added in c4a1d72 actually have impacts on workflow/tagging, or is that just metadata?

There should be no impact to the workflow/tagging. It should update the documentation title from: FIREWHEEL Documentation — FIREWHEEL 0.1.dev1+g7cc3f1fb2 documentation to something like FIREWHEEL Documentation — FIREWHEEL 2.9.0.dev1 documentation. I have verified that it at least removes the +g7cc3f1fb2, but it is unclear if the version number will be corrected as that is much harder to test/verify.

@sdelliot sdelliot merged commit f11f385 into sandialabs:main Sep 23, 2025
15 checks passed
@sdelliot sdelliot deleted the docs-reorganize branch September 23, 2025 22:51
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.

4 participants