Skip to content

Document slug auto-generation for all navigation items #5736

Open
fern-api[bot] wants to merge 1 commit into
mainfrom
fern/document-slug-generation
Open

Document slug auto-generation for all navigation items #5736
fern-api[bot] wants to merge 1 commit into
mainfrom
fern/document-slug-generation

Conversation

@fern-api

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

Copy link
Copy Markdown
Contributor

Summary

The navigation page previously only mentioned slug auto-generation in the context of folders ('Converts filenames to titles and URL slugs'). This PR adds a comprehensive 'Slugs and URL paths' section that documents how Fern auto-generates slugs for all navigation items — sections, pages, folders, tabs, versions, and products.

Changes

  • Added a new '## Slugs and URL paths' section with:
    • A table showing slug derivation source for each navigation item type
    • Explanation of slug override (relative to position in hierarchy)
    • Explanation of skip-slug and which items support it
    • Cross-reference to frontmatter slug (absolute override)
  • Added a note under 'Add a section' that sections support slug and skip-slug (previously undocumented on this page)
  • Updated the folder bullet list to link to the new slug section instead of being the only mention of slug generation
  • Updated the page meta description to include 'URL slugs'

Requested by: Fern Support

@fern-api fern-api Bot requested a review from devalog as a code owner June 9, 2026 20:53
</ParamField>
</Accordion>

## Slugs and URL paths

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] 'Slugs and URL paths' should use sentence-style capitalization.

@github-actions

github-actions Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

🌿 Preview your docs: https://fern-preview-fern-document-slug-generation.docs.buildwithfern.com/learn

Here are the markdown pages you've updated:

@fern-api

fern-api Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor Author

Requested by: devin
Slack thread: View conversation

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