fix(docs): correct version command schema and config nav hierarchy - #555
Merged
Conversation
- Remove --dry-run from the version command schema (elastic version rejects the flag at runtime; closes elastic#554) - Nest configuration_reference.md under configuration.md in docset.yml nav (closes elastic#553 partial — nav hierarchy fix) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
theletterf
marked this pull request as draft
August 19, 2026 08:33
- Fix docset.yml child path: docs-builder resolves children relative to the parent's directory, so the child path must be configuration_reference.md (not cli/configuration_reference.md) - Fix dry-run in schema: use a plain Command for the version stub in cli-schema.ts so the factory does not inject --dry-run. The previous direct schema.json edit bypassed the generator; this fixes the root cause. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
🔍 Preview links for changed docs⏳ Building and deploying preview... View progress This comment will be updated with preview links when the build is complete. |
Contributor
✅ Elastic Docs Style Checker (Vale)No issues found on modified lines! The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale. |
theletterf
marked this pull request as ready for review
August 19, 2026 09:49
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
JoshMock
approved these changes
Aug 20, 2026
Merged
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.
Summary
--dry-runfrom theversioncommand indocs/cli/schema.json— the CLI binary rejects the flag at runtime witherror: unknown option '--dry-run'. Closes [docs] Not all commands support--dry-run, but reference docs include it #554.configuration_reference.mdunderconfiguration.mdindocs/docset.ymlso the config reference appears as a child page in the nav. Addresses the nav nit raised in Text mode renders API errors as raw JSON instead of human-readable messages #100.Test plan
elastic version --dry-runis no longer listed in the rendered reference docsPart of #100.