Skip to content

Commit 0cdf9ff

Browse files
vladfranguTC-MO
andauthored
docs: pseudo-automated new reference markdown file (#747)
As requested by @TC-MO, I've pseudo-automated the generation of the reference file that people see on our docs! I will add in more documentation on how to alter this later (more specifically handling new commands added to the CLI), as its a manual mapping of commands (unfortunately couldn't do it fully automated due to some commands having different positions across the categories) There probably is a better way to handle this in the future, I just did the speedy way for now. Ideally, we'd use oclif's systems to load all commands, store some specific field on each command class and rely on that to map commands around, but even then we'll need to handle custom ordering which might make it janky. To be determined --------- Co-authored-by: Michał Olender <[email protected]>
1 parent 5b1c66d commit 0cdf9ff

File tree

9 files changed

+1973
-1521
lines changed

9 files changed

+1973
-1521
lines changed

.github/workflows/check.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,6 @@ on:
88
branches: [master, renovate/**]
99
pull_request:
1010
branches: [master]
11-
# A release via GitHub releases will deploy a latest version
12-
release:
13-
types: [published]
1411

1512
jobs:
1613
build_and_test:
@@ -51,6 +48,9 @@ jobs:
5148
APIFY_CLI_DISABLE_TELEMETRY: 1
5249
run: yarn test
5350

51+
- name: Ensure the reference documentation builds
52+
run: yarn update-docs
53+
5454
test_python_support:
5555
name: Test Python template support
5656
strategy:

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,5 @@ package.tgz
2323
test/tmp
2424
oclif.manifest.json
2525
tmp
26+
27+
scripts/temporary-reference.md

0 commit comments

Comments
 (0)