Skip to content

CLI generator docs: add configuration, publishing, and retries #6020

Open
fern-api[bot] wants to merge 2 commits into
mainfrom
fern/cli-docs-parity
Open

CLI generator docs: add configuration, publishing, and retries #6020
fern-api[bot] wants to merge 2 commits into
mainfrom
fern/cli-docs-parity

Conversation

@fern-api

@fern-api fern-api Bot commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Brings CLI generator documentation closer to parity with SDK language docs.

Changes

New pages:

  • Configuration — documents all generators.yml options for the CLI generator (binaryName, customCommands) plus shared options (github, output, audiences, smart-casing, metadata, api) with examples.
  • Publishing — documents distribution to npm, Homebrew, and GitHub Releases including CI workflow, build targets, and npm auth.

Updated pages:

  • Features — added "Retries with backoff" section documenting the built-in retry policy (4 attempts, 500ms base, 2x backoff, retryable status codes, idempotency rules, --no-retry flag).
  • Overview — added cross-reference links to the new Publishing and Local generation pages.
  • Navigation — added Configuration and Publishing pages to the sidebar.

Requested by: Fern Support

@fern-api fern-api Bot requested a review from devalog as a code owner June 29, 2026 19:55
@fern-api

fern-api Bot commented Jun 29, 2026

Copy link
Copy Markdown
Contributor Author

Requested by: devin.logan
Slack thread: View conversation


## Retries with backoff

Failed requests are retried automatically with exponential backoff. A request retries as long as the status code is retryable and the retry limit has not been reached.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'hasn't' instead of 'has not'.

| `aarch64-apple-darwin` | macOS | Apple Silicon |
| `x86_64-pc-windows-msvc` | Windows | x86_64 |

### npm publishing

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'npm publishing' should use sentence-style capitalization.

@github-actions

github-actions Bot commented Jun 29, 2026

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