Skip to content

Commit c4998a0

Browse files
committed
fix(docs): keep the changelog and weekly archive reachable
Rames' review on #2978. Two pages left the sidebar without a redirect and without being deleted, so they survived only as direct URLs: `docs/changelog.mdx` and `docs/weekly-updates.mdx`. Not deliberate, and the stack says so — #2979 upgrades `weekly-updates.mdx`, importing DocsVideo and converting four raw <video> tags. You do not invest in a page you meant to retire, and it carries `rss: true`, so it is a subscribable feed. `product-updates.mdx`, which this stack adds to both the nav and the footer, links to `/changelog` three times and `/weekly-updates` once. One of those is advice to read the release archive before upgrading a production workflow. Both are back in the Explore group next to Product updates, which is where a reader looking for "what changed" would go. Worth naming why the verification missed it: the checker walks navigation → file, which is why it correctly reported zero dangling entries. The file → navigation direction — a page that exists, is not in the sidebar, and has no redirect — was never checked, and that is exactly where these two sat. `--check-redirects` on the existing `mint broken-links` step closes the adjacent gap: it resolves every redirect destination, so a future restructure cannot leave a redirect pointing at a page it removed. It does not catch the orphan case above. Also retargets `/guides/pipeline`. It pointed at `/concepts`, which explains how a project is put together; the retired page was a seven-step process. `/workflows` is the closer intent. The old step 3, "Strategy & Messaging", has no successor anywhere in the docs — worth deciding deliberately rather than routing around.
1 parent 25a7df5 commit c4998a0

2 files changed

Lines changed: 7 additions & 3 deletions

File tree

.github/workflows/docs.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,4 +49,6 @@ jobs:
4949

5050
- name: Check broken links
5151
working-directory: docs
52-
run: npx mint broken-links
52+
# --check-redirects also resolves every redirect destination, so a
53+
# restructure cannot leave a redirect pointing at a page it removed.
54+
run: npx mint broken-links --check-redirects

docs/docs.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,9 @@
6464
"group": "Explore",
6565
"pages": [
6666
"examples",
67-
"product-updates"
67+
"product-updates",
68+
"weekly-updates",
69+
"changelog"
6870
]
6971
},
7072
{
@@ -748,7 +750,7 @@
748750
},
749751
{
750752
"source": "/guides/pipeline",
751-
"destination": "/concepts",
753+
"destination": "/workflows",
752754
"permanent": true
753755
},
754756
{

0 commit comments

Comments
 (0)