Docs: Organize component list in index.adoc - #405
Merged
Conversation
leandrumartin
requested changes
Oct 19, 2025
leandrumartin
left a comment
leandrumartin
left a comment
Collaborator
There was a problem hiding this comment.
Thank you for your contribution! There is just one small change to make.
|
|
||
| include::components/outputComponents/fan.adoc[] | ||
|
|
||
| include::components/outputComponents/fourDigitSevenSegment.adoc[] |
Collaborator
There was a problem hiding this comment.
I think this should actually be moved up to the first in the list, as it is displays as "4-digit 7-segment display" in the document title. So since it starts with a number, it would be first alphabetically.
Contributor
Author
There was a problem hiding this comment.
Thanks for the feedback! I've made the requested change and pushed the update
Contributor
Author
|
Hi @leandrumartin, I've addressed your feedback and updated the branch. The PGP signing check is failing as expected for a PR from a fork, but all other checks are passing. Thanks |
leandrumartin
approved these changes
Oct 20, 2025
Collaborator
|
Looks perfect, thank you! |
leandrumartin
added
the
hacktoberfest-accepted
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request Summary:
This PR organizes and updates the main documentation index file (index.adoc). These changes improve the readability of the documentation's table of contents for end-users and enhance the source file's maintainability for future contributors.
This also fixes a bug where the Reed Switch documentation was not being included on the documentation homepage. No automated tests are required, as this is a documentation-only change.
PR Checklist
[x] Closes #402
[x] Tests pass
[x] Any related documentation has been updated, if necessary
Detailed Description:
This pull request addresses three specific improvements for the index.adoc file as outlined in issue #402:
1.Alphabetized Components: The include statements for inputComponents and outputComponents have been reordered alphabetically based on the user-facing title of each component. This makes the table of contents sidebar on the website much easier to navigate.
2.Added Reed Switch: The missing include::components/inputComponents/reedSwitch.adoc[] line has been added to its correct alphabetical position, ensuring it's no longer omitted from the documentation.
3.Added Comments: Comments (//) have been added to the source file to clearly separate the different component sections, making the file easier to read and edit in the future.