chore(docs): create cli docs and remove old docs and their generation#1349
Merged
chance-coleman merged 11 commits intomainfrom Mar 17, 2026
Merged
chore(docs): create cli docs and remove old docs and their generation#1349chance-coleman merged 11 commits intomainfrom
chance-coleman merged 11 commits intomainfrom
Conversation
chance-coleman
commented
Mar 17, 2026
mjnagel
reviewed
Mar 17, 2026
Contributor
mjnagel
left a comment
There was a problem hiding this comment.
Need to go through the main content still, but some initial feedback/questions on a few things.
mjnagel
reviewed
Mar 17, 2026
mjnagel
reviewed
Mar 17, 2026
Contributor
mjnagel
left a comment
There was a problem hiding this comment.
LGTM overall - one other comment might be on the current reference/cli/commands path for all the generated CLI docs. Feels like we could reduce the nesting there at least by a level (reference/commands since we're under the CLI product slug already). Maybe also need to eval UX feedback on there being a nested page (commands) alongside a "bare page" (schema validation).
mjnagel
previously approved these changes
Mar 17, 2026
mjnagel
reviewed
Mar 17, 2026
mjnagel
approved these changes
Mar 17, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
New docs structure — Replaced the auto-generated CLI reference docs (
docs/reference/CLI/anddocs/reference/bundles/) with a human-authored structure:docs/getting-started/— installation, overview, quickstartdocs/how-to-guides/— bundle overrides, UDS runner, monitor clusterdocs/docs.config.jsonto useid: "cli"with the new sidebar orderDead code removal — Deleted the old docs generation/validation pipeline:
hack/generate-docs.sh,hack/test-docs.sh,tasks/docs.yamlgen-cli-docscobra command fromsrc/cmd/internal.goand its lang constantsTest docsCI step from.github/workflows/test-schema-and-docs.yamlDev tooling — Added two uds tasks for working with docs locally:
uds run dev-docs— clones the uds-docs branch, builds with local CLI docs viaDOCS_OVERRIDES, and previewsuds run uds-docs-validate— CI-style validation build against the published uds-docsRelated Issue
Fixes core-112
Type of change
Checklist before merging