Skip to content

Commit

Permalink
feat: revamped oclif-powered docs (#1081)
Browse files Browse the repository at this point in the history
## 🧰 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?

<sub>this is an <code>oclif</code> supremacy account</sub>
  • Loading branch information
kanadgupta authored Nov 22, 2024
1 parent fafe77f commit 8a2833b
Show file tree
Hide file tree
Showing 34 changed files with 1,062 additions and 838 deletions.
2 changes: 2 additions & 0 deletions .alexrc.yml
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
profanitySureness: 1
allow:
- postman-postwoman
2 changes: 1 addition & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ coverage/
# release build artifacts
CHANGELOG.md
dist/
documentation/commands.md
documentation/commands
dist-gha/
395 changes: 67 additions & 328 deletions README.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion bin/run.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ async function main() {
opts.args = stringArgv(process.env.INPUT_RDME);
}
await execute(opts).then(msg => {
if (msg) {
if (msg && typeof msg === 'string') {
// eslint-disable-next-line no-console
console.log(msg);
}
Expand Down
Loading

0 comments on commit 8a2833b

Please sign in to comment.