fix(admin-cli): stabilize generated CLI docs - #4471
Draft
poroh wants to merge 1 commit into
Draft
Conversation
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
Contributor
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Comment |
poroh
force-pushed
the
fix/stable-cli-doc-generation
branch
from
August 1, 2026 15:55
1c936e0 to
599be5a
Compare
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
1 participant
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.
The checked-in
nico-admin-clireference contained manual edits that were not represented in the Clap command definitions. Regenerating the documentation could therefore overwrite useful operator guidance. Pandoc versions also produced different Markdown formatting, creating large unrelated diffs.This PR moves the relevant descriptions back into the authoritative Clap sources and makes
generate-cli-docsdeterministic across supported Pandoc versions. The generator now preserves apostrophes, inline code, and Markdown links while normalizing value lists and hard breaks without reformatting unrelated prose.The complete reference is regenerated from the current command tree, including pages for commands that were previously missing from the checked-in documentation.
Related issues
N/A
Type of Change
Breaking Changes
Testing
Additional Notes
CI enforcement is intentionally deferred to a separate change that will add a
doc-policejob runningcargo make check-cli-docs.