Skip to content
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 9 commits into from
Nov 22, 2024

Conversation

kanadgupta
Copy link
Member

🧰 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

@kanadgupta kanadgupta added enhancement New feature or request refactor Issues about tackling technical debt documentation Improvements or additions to documentation labels Nov 22, 2024
@kanadgupta kanadgupta marked this pull request as ready for review November 22, 2024 01:23
Copy link
Member

@erunion erunion left a 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 kanadgupta merged commit 8a2833b into next Nov 22, 2024
8 checks passed
@kanadgupta kanadgupta deleted the kanad-2024-11-21/command-docs-revamp branch November 22, 2024 01:28
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]
@kanadgupta
Copy link
Member Author

🎉 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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants