feat(docs): add guides alias
#647
Merged
Conversation
This file contains 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
kanadgupta
added
command:docs
kanadgupta
commented
Oct 27, 2022
| versions: { | ||
| description: 'Versions', | ||
| commands: [], | ||
| }, | ||
| categories: { |
There was a problem hiding this comment.
Rearranged this so the categories in the help screen align with the README.md command reference.
erunion
approved these changes
Oct 27, 2022
| @@ -16,11 +16,11 @@ export function getCategories(): Record< | |||
| > { | |||
| return { | |||
| apis: { | |||
| description: 'Upload OpenAPI/Swagger definitions', | |||
| description: 'OpenAPI / Swagger', | |||
There was a problem hiding this comment.
wayyyy cleaner of a header, good lordt
There was a problem hiding this comment.
the amount of little oversights on the main help screen that we don't notice for literal years lmao
kanadgupta
deleted the
kanad/rm-5581-deprecate-docs-in-favor-of-guides
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
🧰 Changes
Adds an alias for the
docsfamily of commands calledguides, as well as some corresponding documentation touch-ups. Note that thedocs:editcommand doesn't have a corresponding alias since that command is now deprecated (see #646).🧬 QA & Testing
Does the alias'ing approach + the corresponding docs look good?