Conversation
Mpdreamz
left a comment
There was a problem hiding this comment.
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 :)
📝 WalkthroughWalkthroughThree documentation files are updated to describe the CLI schema regeneration workflow. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches✨ Simplify code
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. Comment |
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
CONTRIBUTING.mdAdded CLI reference maintenance after the watch section:
dotnet run --project src/tooling/docs-builder -- __schema > docs/cli-schema.jsonversionfield ignored)docs/cli/docs/cli/cli-reference-how-to.mdAdded a Maintaining docs-builder itself note in step 1 with the same regen command and a link to CONTRIBUTING.
AGENTS.mdandCLAUDE.mdAdded a CLI changes bullet under Essential Commands with the regen command and CONTRIBUTING link.
CLAUDE.mdalready matched (likely kept in sync withAGENTS.md).Generative AI disclosure
Tool(s) and model(s) used: composer-2.5-fast