Skip to content

Document site-level changelog for multi-product docs sites - #6996

Open
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1789664949-site-level-changelog
Open

devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1789664949-site-level-changelog

Conversation

@devin-ai-integration

Copy link
Copy Markdown
Contributor

Summary

Multi-product docs sites (those using the top-level products: key in docs.yml) can now have one shared changelog for the whole site. It's configured with a new top-level changelog: key next to products: and is served at the bare /changelog URL, outside any product slug and absent from the product switcher. Until now, the only way to get a shared changelog was a dedicated "Changelog" product hidden from the switcher with CSS; this replaces that brittle workaround with a first-class, opt-in configuration.

Implements docs for: feat(cli): add site-level changelog for multi-product docs sites (fern-api/fern#17737)
Implements docs for: feat(fdr): support site-level changelog on ProductGroupNode (fern-api/fern-platform#14420)

Pages changed

  • fern/products/docs/pages/navigation/changelogs.mdx — new "Site-level changelog for multi-product sites" section: top-level changelog: example next to products:, /changelog URL, not in the switcher, requires products: (fern check rejects it otherwise), accepts the same options as a navigation changelog.
  • fern/products/docs/pages/navigation/products.mdx — one sentence in the "Remove extra navigation from docs.yml" step noting the top-level changelog exception, linking to the new section.
  • fern/products/docs/pages/changelog/2026-09-17.mdx — new Docs changelog entry (navigation, docs.yml).

Validation

  • pre-commit run --files <changed>: Vale passes on the new content; the 2 errors reported in products.mdx (lines 171, 179) are pre-existing text not touched here.
  • cd fern && npx --yes fern-api@5.59.0 check --warnings: 0 errors.

Link to Devin session: https://app.devin.ai/sessions/bcb138597f614759a6f550b0613d02f4
Open in Devin Desktop: https://app.devin.ai/desktop/session/bcb138597f614759a6f550b0613d02f4?variant=devin

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