feat(changelog): host the canonical changelog on docs.trunk.io#27
Open
samgutentag wants to merge 3 commits into
Open
feat(changelog): host the canonical changelog on docs.trunk.io#27samgutentag wants to merge 3 commits into
samgutentag wants to merge 3 commits into
Conversation
…r nav Switch the "Changelog" anchor in the sidebar (and footer) from https://trunk.io/changelog to a local /changelog landing page that surfaces the auto-generated changelog drafts produced by the Mintlify changelog feature (added in #25). - `changelog/index.mdx` — landing page listing the 3 May 18 entries as Mintlify `<Update>` blocks, each linking to its full draft. - `docs.json` — anchor + footer href swapped from external trunk.io URL to `/changelog`. New hidden `Changelog` tab claims ownership of `/changelog/*` routes so the top-bar tab indicator stays correct (without the tab, Mintlify falls back to the last visible tab — Code Quality — when on changelog pages). - `.mintignore` — `changelog/` is commented out so the auto-generated drafts build and route locally. Staged for team buy-in on moving the changelog from the marketing site to the docs site. Stacked on #25 — needs that PR's 3 changelog drafts to render correctly. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
Expand the changelog work from a minimal nav swap to a full migration of every historical changelog entry from the marketing site to the docs site, using Mintlify's native <Update> component. Content: - 150 historical entries imported from the closed marketing-site PR #609 (trunk-io/marketing-site) into `changelog/*.mdx`. Combined with the 3 May 2026 bot drafts already on this branch, the docs site now hosts 153 entries spanning 2023-08-01 → 2026-05-18. - 68 image assets copied into `assets/changelog/` (221 MB). Image paths in MDX rewritten from `/changelog-assets/<file>` (marketing convention) → `/assets/changelog/<file>` (Mintlify convention). - Every entry has a `description:` frontmatter field — auto-extracted from the first prose paragraph (announcement-style entries) or the first 1-2 bullets (release-note-style entries like Plugins X.Y.Z), stripped of markdown and YAML-escaped. The 3 bot drafts keep their hand-written descriptions. Nav and rendering: - `changelog/index.mdx` is the canonical unified changelog at `/changelog`. Year + month nested headings (`## 2026` → `### May 2026`) with unique anchor IDs, Mintlify's built-in `<Update>` tag filter pills for per-category filtering, and `rss: true` for an automatic feed. - `merge-queue/changelog.mdx` and `flaky-tests/changelog.mdx` are per-product changelog pages (only the entries tagged for that product), embedded in their respective product tabs. Same generator, scoped to one category. RSS feed per product. - `docs.json` — hidden `Changelog` tab now claims `/changelog/*` routes with a year-grouped sidebar (2026/2025/2024/2023). The `Merge Queue` and `Flaky Tests` tabs each get a "Changelog" page at the end of their main group. - `.mintignore` — `changelog/` line commented out so the directory builds. Category rename: - The "Merge" category is renamed to "Merge Queue" across all 34 affected entries so the tag-filter UI shows the full product name. Cross-repo dependency: - trunk-io/marketing-site#613 (draft) sets up 150 per-slug 301 redirects from trunk.io/changelog/<slug> to the new docs.trunk.io/changelog/<date>-<slug> locations, plus `/changelog` → `docs.trunk.io/changelog`. That PR is held until this one ships. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
samgutentag
force-pushed
the
docs/native-changelog-nav
branch
from
468eb23 to
a3a03a3
Compare
samgutentag
changed the title
Member
Author
|
Verification status (2026-05-19): Verified: pure docs change with no eng dependency. Ready to publish.
Self-sufficient against main (the now-closed #25 was folded in earlier this session). Labels: |
samgutentag
changed the title
samgutentag
changed the title
Member
Author
|
Consolidation (2026-05-19): folded #25's content in. This PR's branch already contains all of #25 (shared commit |
samgutentag
added
the
ready to merge
samgutentag
changed the title
samgutentag
added
the
changelog
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Hosts the canonical Trunk changelog on
docs.trunk.ioinstead oftrunk.io/changelog. Imports the full historical changelog (~200 entries, 2023-present), adds a landing page under the docs sidebar, and consolidates the three new flaky-tests drafts that were originally split into #25.Supersedes #25 — that branch is fully contained in this one (shared commit
26f779c). Close #25 when merging this.Changes
changelog/— imports the full historical changelog as Mintlify<Update>entries, from2023-08-01-plugins-1-1-0.mdxthrough2026-05-18-flaky-tests-test-labels.mdx(the three latest entries originally drafted in [close - superseded by #27] docs: draft weekly changelog for flaky tests updates #25).changelog/index.mdx— new landing page listing the most recent entries.assets/changelog/— imports the ~70 image assets referenced by historical entries.flaky-tests/changelog.mdxandmerge-queue/changelog.mdx— per-product changelog routes.docs.json—Changeloganchor + footer link href swapped fromhttps://trunk.io/changelog→/changelog. New hiddenChangelogtab claims/changelog/*routes so the top-bar tab indicator stays correct on changelog pages..mintignore—changelog/line removed so the entries build and route locally.Trade-offs to discuss with the team
trunk.io/changelog(marketing). The team needs to decide on a single source of truth.trunk.io/changelogcurrently gets marketing-site SEO. Moving todocs.trunk.iocould change inbound traffic patterns.trunk.io/changeloghas a separate workflow. The team needs to align on which one drives.Test plan
mint devand click "Changelog" in the sidebar. Confirm it lands on/changelog./changelog/*does NOT activate the Code Quality tab in the top bar.