Reorganize layout of G-Codes.md#5209
Merged
Merged
Conversation
Break listing up by module name. Provide links to "extended" commands. Sort reference by module name. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
f97da0b to
c80552f
Compare
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
1 participant
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.
This change reorganizes the layout of the G-Codes.md file. The big advantage of this change is that most commands will now have a direct URL for them. This will hopefully make it easier to pass along links to the command reference.
As part of this change, I've also reorganized the document by module name, and I've sorted the document alphabetically by module name. This may be a little confusing to users as some similar commands may no longer be close to each other within the document. Also, some modules are "internal" and aren't typically exposed to users (eg, query_endstops, toolhead, manual_move). However, the existing document seems very "scattered" to me, so I don't think the new document is really worse off in general.
-Kevin