Skip to content

Commit ea70315

Browse files
reubenoreubeno
authored
docs: add auto-generated CLI reference docs and integrate into build (#499)
Add magesrc.GenerateDocs() and hook it into 'mage build' so CLI reference docs are regenerated automatically on every build. Include the generated CLI reference Markdown files (one per command, produced by 'azldev docs markdown --include-hidden'). These files should not be hand-edited; update the Cobra command definitions in Go source code instead, then run 'mage build' to regenerate. Mark docs/user/reference/cli/ as linguist-generated so that GitHub collapses them in diffs and excludes them from language statistics.
1 parent 2e3464d commit ea70315

36 files changed

+1818
-0
lines changed

‎.gitattributes‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Auto-generated CLI reference docs — hidden in diffs, excluded from language stats.
2+
docs/user/reference/cli/** linguist-generated

‎docs/user/reference/cli/azldev.md‎

Lines changed: 44 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/user/reference/cli/azldev_advanced.md‎

Lines changed: 43 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/user/reference/cli/azldev_advanced_mcp.md‎

Lines changed: 51 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/user/reference/cli/azldev_advanced_mock.md‎

Lines changed: 41 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/user/reference/cli/azldev_advanced_mock_build-rpms.md‎

Lines changed: 58 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/user/reference/cli/azldev_advanced_mock_shell.md‎

Lines changed: 63 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/user/reference/cli/azldev_advanced_wget.md‎

Lines changed: 52 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)