Skip to content

Commit d91c1b7

Browse files
docs: split changelog into yearly pages for SEO/AEO (#29)
* docs: split changelog into yearly pages for SEO/AEO Split the single 4,002-line changelog/index.mdx into 6 yearly pages (2021-2026). The original index.mdx becomes a thin landing page linking to each year. - Create yearly pages: changelog/2021.mdx through changelog/2026.mdx - Update sidebar config to list all yearly pages - Add changelog to llms.txt custom sets (no longer excluded) - Update update-changelog skill for yearly file targeting - Update AFDocs known-exceptions for resolved page-size warning Co-Authored-By: Oz <oz-agent@warp.dev> * docs: polish changelog frontmatter descriptions Reduce Warp repetition and include auto-update info. Co-Authored-By: Oz <oz-agent@warp.dev> * docs: address PR review — drop month ranges, remove auto-update claim Co-Authored-By: Oz <oz-agent@warp.dev> --------- Co-authored-by: Oz <oz-agent@warp.dev>
1 parent b1c2f95 commit d91c1b7

11 files changed

Lines changed: 4102 additions & 4033 deletions

File tree

.agents/skills/afdocs-audit/references/known-exceptions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ This file lists checks from the afdocs-audit skill that may flag as warnings or
3636

3737
## page-size-markdown / page-size-html
3838

39-
**Expected status**: warn — but only allowlist `/changelog/`
40-
**Reason**: The changelog page (`/changelog/`) is intentionally a single long page (~4,000 lines of MDX). It is excluded from `llms-full.txt` generation due to a `hast-util-to-text` stack overflow, but is still accessible at its URL and indexed by the sitemap.
41-
**Action**: If the only flagged page is `/changelog/`, classify as allowlisted. If other pages are flagged, treat those as genuine issues that may need splitting.
39+
**Expected status**: pass (after changelog split)
40+
**Reason**: The changelog was split into yearly pages in May 2026, resolving the page-size issue. No pages should flag this check now.
41+
**Action**: If any page is flagged, treat it as a genuine issue that may need splitting.
4242

4343
## section-header-quality
4444

.agents/skills/update-changelog/SKILL.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Update the public changelog at docs.warp.dev/changelog with the lat
55

66
# Update Changelog
77

8-
Adds a new entry to `src/content/docs/changelog/index.mdx` for the latest stable Warp release, then opens a PR.
8+
Adds a new entry to the current year's changelog page (e.g. `src/content/docs/changelog/2026.mdx`) for the latest stable Warp release, then opens a PR.
99

1010
## Related Skills
1111

@@ -35,7 +35,23 @@ Parse it into components:
3535

3636
### Step 2: Check if already documented
3737

38-
Read `src/content/docs/changelog/index.mdx` and search for the base version in existing `### ` header lines. If found, report that the changelog is already up to date and stop.
38+
Determine the year from the display date (e.g. `2026` from `2026.02.18`). The target file is `src/content/docs/changelog/{year}.mdx`.
39+
40+
If the year file doesn't exist yet (year rollover), create it using this template:
41+
42+
```markdown
43+
---
44+
title: "Changelog — {year}"
45+
description: >-
46+
Warp release notes for {year}. Updates ship weekly, typically on Thursdays.
47+
---
48+
49+
Submit bugs and feature requests on our [GitHub board!](https://github.com/warpdotdev/Warp/issues/new/choose)
50+
```
51+
52+
Also update `src/content/docs/changelog/index.mdx` to add a link for the new year at the top of the list, and update `src/sidebar.ts` to add the new year entry.
53+
54+
Read the target year file and search for the base version in existing `### ` header lines. If found, report that the changelog is already up to date and stop.
3955

4056
### Step 3: Fetch changelog data from `channel_versions.json` (primary source)
4157

@@ -190,7 +206,7 @@ Reference the `2026.02.10` entry in the existing changelog for the exact `<figur
190206

191207
### Step 6: Insert into the changelog file
192208

193-
Edit `src/content/docs/changelog/index.mdx`:
209+
Edit `src/content/docs/changelog/{year}.mdx` (the year file determined in Step 2):
194210
- Find the first line that starts with `### ` (this is the most recent existing entry)
195211
- Insert the new entry **immediately before** that line
196212
- Ensure there is exactly one blank line between the description paragraph ("Submit bugs and feature requests...") and the new entry's `### ` header
@@ -203,7 +219,7 @@ Edit `src/content/docs/changelog/index.mdx`:
203219
git checkout -b changelog/{base_version}
204220

205221
# Stage and commit
206-
git add src/content/docs/changelog/index.mdx
222+
git add src/content/docs/changelog/
207223
git commit -m "docs: add changelog entry for {base_version}
208224
209225
Co-Authored-By: Oz <oz-agent@warp.dev>"

astro.config.mjs

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -157,9 +157,7 @@ export default defineConfig({
157157
// (excluded globally above — ~25k lines causes a stack overflow in hast-util-to-text).
158158
{ label: 'Support', description: 'Troubleshooting, billing, and privacy.', paths: ['support-and-community/index', 'support-and-community/plans-and-billing/**', 'support-and-community/privacy-and-security/**', 'support-and-community/troubleshooting-and-support/**', 'support-and-community/community/contributing', 'support-and-community/community/open-source-partnership', 'support-and-community/community/refer-a-friend'] },
159159
{ label: 'Guides', description: 'Task-oriented walkthroughs and tutorials.', paths: ['guides/**'] },
160-
// Changelog excluded — the single page (4k lines) causes a stack overflow
161-
// in hast-util-to-text during llms-full.txt generation. The page is still
162-
// available at /changelog/ and indexed by the sitemap.
160+
{ label: 'Changelog', description: 'Warp release notes by year.', paths: ['changelog/**'] },
163161
],
164162
}),
165163
],

0 commit comments

Comments
 (0)