-
Notifications
You must be signed in to change notification settings - Fork 43
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
feat: revamped oclif
-powered docs
#1081
Merged
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
enhancement
New feature or request
refactor
Issues about tackling technical debt
documentation
Improvements or additions to documentation
labels
Nov 22, 2024
erunion
approved these changes
Nov 22, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
as the kids say, oclif is goated with the sauce
kanadgupta
pushed a commit
that referenced
this pull request
Nov 22, 2024
# [9.0.0-next.31](v9.0.0-next.30...v9.0.0-next.31) (2024-11-22) ### Features * revamped `oclif`-powered docs ([#1081](#1081)) ([8a2833b](8a2833b)) [skip ci]
🎉 This PR is included in version 9.0.0-next.31 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
kanadgupta
added a commit
that referenced
this pull request
Nov 22, 2024
## 🧰 Changes a few contributing doc cleanups, some of which i forgot to include in #1081.
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
enhancement
New feature or request
refactor
Issues about tackling technical debt
released on @next
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
Overhauls all of our command docs and creates a new
documentation/commands/
directory with pages for each of the command categories.I took all of the command-specific docs + examples from
README.md
and moved them into each respective command's code.🧬 QA & Testing
Do all of the docs changes look sound? Is there any loss in information?
this is an
oclif
supremacy account