Skip to content

Document changelog timeline redesign, per-entry tags, and search#5932

Open
fern-api[bot] wants to merge 3 commits into
mainfrom
devin/1782247122-changelog-docs
Open

Document changelog timeline redesign, per-entry tags, and search#5932
fern-api[bot] wants to merge 3 commits into
mainfrom
devin/1782247122-changelog-docs

Conversation

@fern-api

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

Copy link
Copy Markdown
Contributor

Summary

Documents the changelog page redesign from fern-platform#12385, which replaces the full-height inline entry layout with a compact, date-grouped timeline of cards with built-in search and tag filtering.

Key documentation additions to changelogs.mdx:

  • Timeline layout — Updated intro to describe the new scannable card-based timeline grouped by date
  • <ChangelogTags> per-entry tagging — New "Per-entry tags" subsection documenting how authors can tag individual headings within a single changelog file using <ChangelogTags>tag1, tag2</ChangelogTags> or <ChangelogTags tags={["tag1", "tag2"]} />
  • Search and filtering section — New ## Search and filtering section covering full-text search (?q= param) and clickable tag badges that link back to the filtered timeline
  • Fixes — Corrected a broken component library link (/learn/docs/content/.../learn/docs/writing-content/...)

Also includes:

  • Updated changelog card description on the configuration overview page to mention search
  • New changelog entry (2026-06-23.mdx) announcing the timeline redesign and per-entry tags

Requested by: Fern Support

- Update changelogs.mdx with timeline layout, full-text search, and
  ChangelogTags per-entry tagging documentation
- Add Search and filtering section covering ?q= search and clickable tags
- Update configuration overview card description
- Fix broken component library link

Co-Authored-By: bot_apk <apk@cognition.ai>
@fern-api fern-api Bot requested a review from devalog as a code owner June 23, 2026 20:43

When a heading has a `<ChangelogTags>` marker, those tags replace the frontmatter tags for that entry's card on the timeline. Headings without a marker inherit the frontmatter tags as usual.

Use specific, descriptive tags that readers would naturally search for. Consider tagging by feature type, product area, release stage, affected platform, or user impact.

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.Adverbs] Remove 'naturally' if it's not important to the meaning of the statement.


The changelog page includes a search bar and tag filter at the top of the timeline. Both are available to readers without any additional configuration.

- **Full-text search** — Readers can type keywords into the search bar to find entries across the entire changelog, not just the entries visible on the current page. The query syncs to the `?q=` URL parameter, so search results are shareable as links.

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.Hedges] Avoid hedge words and filler like 'just'. Prefer direct statements.

@github-actions

github-actions Bot commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

@fern-api

fern-api Bot commented Jun 23, 2026

Copy link
Copy Markdown
Contributor Author

Requested by: devin.logan
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