-
Notifications
You must be signed in to change notification settings - Fork 88
docs(#5598): add CLI-to-documentation cross-reference guide #6375
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
Merged
waynesun09
merged 4 commits into
fullsend-ai:main
from
shairevivo:srevivo/docs-5598-cli-doc-crossref
Aug 20, 2026
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
c501fce
docs(#5598): add CLI-to-documentation cross-reference guide
shairevivo 28c56c8
fix(#5598): address review — complete mint/repos cross-refs, fix heading
shairevivo dde47ff
fix(#5598): address review round 2
shairevivo 0260ab2
Merge branch 'main' into srevivo/docs-5598-cli-doc-crossref
shairevivo File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| --- | ||
| title: Documentation | ||
| --- | ||
|
|
||
| # Documentation | ||
|
|
||
| When changing CLI command behavior, adding or removing subcommands, or renaming flags, you must update every documentation file that references the affected command. CLI commands are documented across CLI reference pages, user and operator guides, ADRs, and inline Go help text. Missing even one location causes documentation drift that surfaces as review findings on later PRs. | ||
|
|
||
| ## General discovery rule | ||
|
|
||
| Before considering a CLI change complete, run: | ||
|
|
||
| ```bash | ||
| grep -rn '<command-name>' docs/ internal/cli/ | ||
| ``` | ||
|
|
||
| The `internal/cli/` path covers inline `Short`/`Long` help text in Go source. Review every hit and update references that describe behavior you changed. This catches files not listed in the cross-reference below. | ||
|
|
||
| ## ADR annotations | ||
|
|
||
| When a CLI change makes an ADR's decision obsolete, write a **new ADR** that supersedes the old one rather than editing the original decision text. Minor annotations (status updates, "see also" links) are welcome — see [ADR conventions](adrs.md) for the full rules. | ||
|
|
||
| ## Cross-reference by command group | ||
|
|
||
| Each row lists the documentation touchpoints for a major CLI command group. The **Go source** column is where inline `Short`/`Long` help text lives. | ||
|
|
||
| ### `agent` | ||
|
|
||
| | Category | Files | | ||
| |----------|-------| | ||
| | CLI reference | `docs/cli/agent.md` | | ||
| | Guides | `docs/guides/getting-started/operations.md`, `docs/guides/user/bring-your-own-agent.md`, `docs/guides/user/customizing-agents.md`, `docs/guides/user/customizing-with-skills.md`, `docs/guides/dev/cli-internals.md` | | ||
| | ADRs | `docs/ADRs/0058-agent-registration.md` | | ||
| | Go source | `internal/cli/agent.go` | | ||
|
|
||
| ### `admin foreign` | ||
|
|
||
| The `admin` command group's `install`/`uninstall`/`analyze`/`enable`/`disable` subcommands are deprecated per-org installation tooling ([ADR-0044](../ADRs/0044-deprecate-per-org-installation-mode.md)). The actively supported subcommand is `admin foreign` (cross-org mint-authorization allow-list). | ||
|
|
||
| | Category | Files | | ||
| |----------|-------| | ||
| | CLI reference | _(no dedicated page)_ | | ||
| | Guides | `docs/guides/infrastructure/mint-administration.md`, `docs/guides/dev/cli-internals.md`, `docs/guides/dev/e2e-testing.md` | | ||
| | ADRs | `docs/ADRs/0060-cross-org-mint-authorization-via-org-variables.md`, `docs/ADRs/0083-repo-level-foreign-allow-list.md` | | ||
| | Go source | `internal/cli/admin.go` | | ||
|
|
||
| ### `github` | ||
|
|
||
| | Category | Files | | ||
| |----------|-------| | ||
| | CLI reference | `docs/cli/github.md` | | ||
| | Guides | `docs/guides/getting-started/configuring-github.md`, `docs/guides/getting-started/operations.md`, `docs/guides/dev/cli-internals.md`, `docs/guides/dev/e2e-testing.md` | | ||
| | ADRs | `docs/ADRs/0057-repos-management.md` | | ||
| | Go source | `internal/cli/github.go` | | ||
|
|
||
| ### `inference` | ||
|
|
||
| | Category | Files | | ||
| |----------|-------| | ||
| | CLI reference | `docs/cli/inference.md` | | ||
| | Guides | `docs/guides/getting-started/getting-inference.md`, `docs/guides/getting-started/operations.md`, `docs/guides/dev/cli-internals.md` | | ||
| | Go source | `internal/cli/inference.go` | | ||
|
|
||
| ### `mint` | ||
|
|
||
| | Category | Files | | ||
| |----------|-------| | ||
| | CLI reference | `docs/cli/mint.md` | | ||
| | Guides | `docs/guides/getting-started/operations.md`, `docs/guides/getting-started/org-mode.md`, `docs/guides/infrastructure/mint-administration.md`, `docs/guides/infrastructure/infrastructure-reference.md`, `docs/guides/infrastructure/advanced-setup.md`, `docs/guides/infrastructure/standalone-mint.md`, `docs/guides/dev/cli-internals.md` | | ||
| | ADRs | `docs/ADRs/0059-public-mint-mode-with-wildcard-allowlists.md`, `docs/ADRs/0060-cross-org-mint-authorization-via-org-variables.md`, `docs/ADRs/0073-named-mint-privilege-levels.md`, `docs/ADRs/0077-mint-repos-scope-hardening.md`, `docs/ADRs/0078-simplified-mint-authorization-policy.md`, `docs/ADRs/0082-workflow-host-allow-list.md` | | ||
| | Go source | `internal/cli/mint.go`, `internal/cli/mint_setup.go`, `internal/cli/mint_delete.go`, `internal/cli/minttoken.go` | | ||
|
|
||
| ### `repos` | ||
|
|
||
| | Category | Files | | ||
| |----------|-------| | ||
| | CLI reference | `docs/cli/repos.md` | | ||
| | Guides | `docs/guides/getting-started/operations.md`, `docs/guides/getting-started/repo-management.md`, `docs/guides/getting-started/getting-inference.md`, `docs/guides/dev/cli-internals.md` | | ||
| | ADRs | `docs/ADRs/0057-repos-management.md`, `docs/ADRs/0074-repos-command-consolidation.md` | | ||
| | Go source | `internal/cli/repos.go`, `internal/cli/repos_gitlab.go` | | ||
|
|
||
| ### `run` | ||
|
waynesun09 marked this conversation as resolved.
|
||
|
|
||
| | Category | Files | | ||
| |----------|-------| | ||
| | CLI reference | _(no dedicated page)_ | | ||
| | Guides | `docs/guides/user/running-agents-locally.md`, `docs/guides/user/building-custom-agents.md`, `docs/guides/dev/cli-internals.md` | | ||
| | ADRs | `docs/ADRs/0036-agent-execution-sandbox.md` | | ||
| | Contributing | `docs/contributing/sandbox-topology.md` | | ||
| | Go source | `internal/cli/run.go` | | ||
|
|
||
| ### `issues` | ||
|
|
||
| | Category | Files | | ||
| |----------|-------| | ||
| | CLI reference | _(no dedicated page)_ | | ||
| | Guides | `docs/guides/user/issues-commands.md`, `docs/guides/user/jira-integration.md`, `docs/guides/infrastructure/layered-config-reference.md`, `docs/guides/dev/cli-internals.md` | | ||
| | Go source | `internal/cli/issues.go` | | ||
|
|
||
| ## Minor commands | ||
|
|
||
| The commands below have lighter documentation footprints. Apply the general `grep` rule when changing them: | ||
|
|
||
| `dispatch`, `scan`, `lock`, `poll`, `fetch-skill`, `post-review`, `post-comment`, `reconcile-status` | ||
|
|
||
| The most comprehensive single reference for all commands (including minor ones) is `docs/guides/dev/cli-internals.md`, which documents the full command tree with flags. | ||
|
waynesun09 marked this conversation as resolved.
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.