Skip to content

Fix step numbering in SDK quickstarts #5333

Merged
devalog merged 1 commit intomainfrom
fern/fix-python-quickstart-numbering
May 4, 2026
Merged

Fix step numbering in SDK quickstarts #5333
devalog merged 1 commit intomainfrom
fern/fix-python-quickstart-numbering

Conversation

@fern-api
Copy link
Copy Markdown
Contributor

@fern-api fern-api Bot commented May 4, 2026

Summary

The SDK quickstart pages for Python, C#, Go, Java, PHP, Ruby, and Swift had broken step numbering — the visible step count jumped from 3 to 16 part-way through (see https://buildwithfern.com/learn/sdks/generators/python/quickstart for the live example).

Root cause

These pages mixed two patterns inside a single <Steps> block:

  • Explicit <Step title="…"> components (from snippets like init-fern-folder.mdx and setup-github-repos.mdx)
  • Plain ### Add the SDK generator and ### Generate the SDK markdown headings

The renderer auto-numbers <Step> components correctly, but when those headings are mixed in alongside, the headings are not auto-converted to steps. Instead, every loose block between the explicit <Step> from the init-fern-folder snippet (step 3) and the next explicit <Step> from the setup-github-repos snippet (paragraphs, code blocks, <Note>, <Files>, etc.) shifted the count, so "Set up GitHub repositories" rendered as step 16.

Fix

Wrapped the "Add the SDK generator" and "Generate the SDK" content in proper <Step title="…"> components in all 7 affected SDK quickstarts (and their Simplified Chinese translations under fern/translations/zh/). This matches the pattern already used by the Rust and TypeScript quickstarts, which render correctly.

After this change, each quickstart should render as a clean 1-through-N sequence.

Files changed

  • fern/products/sdks/generators/{csharp,go,java,php,python,ruby,swift}/quickstart.mdx
  • fern/translations/zh/products/sdks/generators/{csharp,go,java,php,python,ruby,swift}/quickstart.mdx

Requested by: Fern Support

Wrap content under 'Add the SDK generator' and 'Generate the SDK' headings in <Step> components so they render as numbered steps inside <Steps>. Previously the markdown headings did not auto-convert when mixed with explicit <Step> components, causing the rendered numbering to skip from step 3 to step 16.
@fern-api fern-api Bot requested a review from devalog as a code owner May 4, 2026 11:54
@fern-api
Copy link
Copy Markdown
Contributor Author

fern-api Bot commented May 4, 2026

Requested by: devin
Slack thread: View conversation

@devalog devalog merged commit e194a07 into main May 4, 2026
3 checks passed
@devalog devalog deleted the fern/fix-python-quickstart-numbering branch May 4, 2026 12:07
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.

1 participant