Skip to content

docs: sync generated CLI reference - #9818

Open
medriscoll wants to merge 1 commit into
rilldata:mainfrom
medriscoll:codex/docs-cli-validation
Open

medriscoll wants to merge 1 commit into
rilldata:mainfrom
medriscoll:codex/docs-cli-validation

Conversation

@medriscoll

Copy link
Copy Markdown
Contributor

Summary

  • remove generated pages for retired rill env configure and rill usergroup rename commands
  • remove obsolete example-project text from rill init reference

Validation

  • built the current Rill source CLI
  • verified the official v0.88.6 arm64 archive checksum
  • exercised all 105 current reference command paths with --help against v0.88.6
  • ran isolated rill init, rill validate --pull-env=false, rill start, and rill query --local workflows
  • ran npm ci and npm run build in docs/ successfully

@nishantmonu51 nishantmonu51 added Type:Documentation Improvements or additions to documentation Size:S Small change: under 100 lines labels Sep 1, 2026

@nishantmonu51 nishantmonu51 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The two stale page deletions are correct: neither configure nor rename exists under cli/cmd/env/ or cli/cmd/usergroup/ on main.

Comment on lines -13 to -18
Available example projects:
- rill-cost-monitoring (duckdb)
- rill-github-analytics (duckdb)
- rill-openrtb-prog-ads (duckdb)


Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This hunk was not produced by make docs.generate, so docs-check fails on it. make docs.generate depends on runtime.examples.embed (Makefile:33, Makefile:63), which copies the KEEP_EXAMPLES projects into runtime/pkg/examples/embed/dist before running the generator; examples.List() then populates this block from cli/cmd/initialize/init.go:26. The generator also always emits the trailing blank line removed at the end of the file (cli/cmd/docs/generate_cli.go:173). CI regenerates both and fails with "Generated docs are out of date". Dropping this hunk and keeping only the two page deletions is enough.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Size:S Small change: under 100 lines Type:Documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants