Skip to content

docs(cli-generator): document group help derivation from OpenAPI tags - #6724

Open
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1787505230-cli-group-help-docs
Open

docs(cli-generator): document group help derivation from OpenAPI tags#6724
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1787505230-cli-group-help-docs

Conversation

@devin-ai-integration

Copy link
Copy Markdown
Contributor

Summary

Generated CLIs no longer show Operations on '<group>' for every command group: group --help text is now derived from the OpenAPI document, using root-level tags[].description and overridable per group with x-fern-groups. This matters because API authors get useful CLI help for free from spec prose they already maintain, and x-fern-groups was 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 a plants example, 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 an x-fern-groups subsection covering summary/description, the short-line resolution order (summary → first sentence of description → first sentence of an attributed tag description → Operations on '<name>'), the name-restating summary rule, long help, and the 80-character short-line cap.
  • fern/products/cli-generator/quickstart.mdx — one sentence cross-referencing the new section from the --help walkthrough.

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 the x-fern-groups schema in getFernGroups.ts.

Lint (pre-commit, Vale: 0 errors/warnings/suggestions) and fern check --warnings (0 errors; the 8 warnings are preexisting and unrelated) both pass.

Link to Devin session: https://app.devin.ai/sessions/005b2ff9125446bea0fb18372b62f433

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@github-actions

Copy link
Copy Markdown
Contributor

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants