Skip to content

[DOCS] Add details about regenerating CLI schema#3516

Open
lcawl wants to merge 1 commit into
mainfrom
cli-docs
Open

[DOCS] Add details about regenerating CLI schema#3516
lcawl wants to merge 1 commit into
mainfrom
cli-docs

Conversation

@lcawl

@lcawl lcawl commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

While working on #3513 I noticed that the new command options were not automatically added to the CLI schema and there weren't obvious instructions for doing so.

This PR makes the steps more explicit.

AI summary

  1. CONTRIBUTING.md
    Added CLI reference maintenance after the watch section:

    • Regen command: dotnet run --project src/tooling/docs-builder -- __schema > docs/cli-schema.json
    • CI drift check note (version field ignored)
    • Pointer to supplemental docs in docs/cli/
  2. docs/cli/cli-reference-how-to.md
    Added a Maintaining docs-builder itself note in step 1 with the same regen command and a link to CONTRIBUTING.

  3. AGENTS.md and CLAUDE.md
    Added a CLI changes bullet under Essential Commands with the regen command and CONTRIBUTING link. CLAUDE.md already matched (likely kept in sync with AGENTS.md).

Generative AI disclosure

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No
  1. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.).

Tool(s) and model(s) used: composer-2.5-fast

@lcawl lcawl added the documentation Improvements or additions to documentation label Jun 16, 2026
@lcawl lcawl requested review from a team as code owners June 16, 2026 16:16
@lcawl lcawl requested a review from theletterf June 16, 2026 16:16
@lcawl lcawl temporarily deployed to integration-tests June 16, 2026 16:16 — with GitHub Actions Inactive

@Mpdreamz Mpdreamz left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Still need to add a PR check for this to ensure we generate this as part of the PR. Did that for elastic/cli but not our own :)

@coderabbitai

coderabbitai Bot commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Three documentation files are updated to describe the CLI schema regeneration workflow. CONTRIBUTING.md gains a new "CLI reference maintenance" subsection explaining that contributors must run dotnet run ... -- __schema > docs/cli-schema.json after changing CLI options in src/tooling/docs-builder/Commands/, commit the result, and that CI enforces schema drift (excluding the version field). AGENTS.md adds a parallel "CLI changes" instruction block with the same command and a reference to CONTRIBUTING.md. docs/cli/cli-reference-how-to.md inserts a note callout in the "Create a schema file" step pointing to the same regeneration command and CONTRIBUTING.md.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change—adding documentation details about the CLI schema regeneration process.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description check ✅ Passed The pull request description clearly relates to the changeset, explaining the motivation (missing instructions for CLI schema regeneration) and summarizing the updates across multiple documentation files.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch cli-docs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

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

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants