docs(cli-generator): document group help derivation from OpenAPI tags - #6724
Open
devin-ai-integration[bot] wants to merge 1 commit into
Open
docs(cli-generator): document group help derivation from OpenAPI tags#6724devin-ai-integration[bot] wants to merge 1 commit into
devin-ai-integration[bot] wants to merge 1 commit into
Conversation
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
|
🌿 Preview your docs: https://fern-preview-devin-1787505230-cli-group-help-docs.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
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
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
Generated CLIs no longer show
Operations on '<group>'for every command group: group--helptext is now derived from the OpenAPI document, using root-leveltags[].descriptionand overridable per group withx-fern-groups. This matters because API authors get useful CLI help for free from spec prose they already maintain, andx-fern-groupswas previously undocumented anywhere in the docs.Implements docs for: feat(cli-generator): derive CLI group help from OpenAPI tags and keep help lines concise (fern-api/fern#17476)
Pages changed
fern/products/cli-generator/openapi-extensions.mdx— new Command group help section: tag-derived help with aplantsexample, the tag attribution rules (name match, or exclusive to the group and covering at least half its operations; colon-scoped tags excluded; ambiguous tags fall back), and anx-fern-groupssubsection coveringsummary/description, the short-line resolution order (summary→ first sentence ofdescription→ first sentence of an attributed tag description →Operations on '<name>'), the name-restatingsummaryrule, long help, and the 80-character short-line cap.fern/products/cli-generator/quickstart.mdx— one sentence cross-referencing the new section from the--helpwalkthrough.Behavior documented was verified against the merged implementation in
generators/cli/sdk/src/openapi/commands.rs(group_about_text_for_group,find_tag_description) and thex-fern-groupsschema ingetFernGroups.ts.Lint (
pre-commit, Vale: 0 errors/warnings/suggestions) andfern check --warnings(0 errors; the 8 warnings are preexisting and unrelated) both pass.Link to Devin session: https://app.devin.ai/sessions/005b2ff9125446bea0fb18372b62f433