Skip to content

Commit 8a2833b

Browse files
authored
feat: revamped oclif-powered docs (#1081)
## 🧰 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>
1 parent fafe77f commit 8a2833b

34 files changed

+1062
-838
lines changed

.alexrc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
11
profanitySureness: 1
2+
allow:
3+
- postman-postwoman

.prettierignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ coverage/
77
# release build artifacts
88
CHANGELOG.md
99
dist/
10-
documentation/commands.md
10+
documentation/commands
1111
dist-gha/

README.md

Lines changed: 67 additions & 328 deletions
Large diffs are not rendered by default.

bin/run.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ async function main() {
1111
opts.args = stringArgv(process.env.INPUT_RDME);
1212
}
1313
await execute(opts).then(msg => {
14-
if (msg) {
14+
if (msg && typeof msg === 'string') {
1515
// eslint-disable-next-line no-console
1616
console.log(msg);
1717
}

0 commit comments

Comments
 (0)