Skip to content

chore: [changelog] redirect docs changelog to dev platform blog #932

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
0xYankee-Raccoons wants to merge 2 commits into
base: main
Choose a base branch
from
Open

chore: [changelog] redirect docs changelog to dev platform blog #932

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7df8822
chore: [changelog] redirect docs changelog to dev platform blog
0xYankee-Raccoons Jul 7, 2026
2c9b5cf
chore: [changelog] point redirect and workflow at developers.jup.ag/c…
0xYankee-Raccoons Jul 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .claude/rules/decisions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,7 @@ Track all redirects added to `vercel.json` here for visibility:
| `/docs/studio/*` | `/studio/*` | 2026-03-28 | Product folders moved to root (DEVREL-133) |
| `/docs/trigger/*` | `/trigger/*` | 2026-03-28 | Product folders moved to root (DEVREL-133) |
| `/docs/ultra/*` | `/ultra/*` | 2026-03-28 | Product folders moved to root (DEVREL-133) |
| `developers.jup.ag/docs/changelog` | `https://developers.jup.ag/changelog` | 2026-07-07 | Changelog consolidated on dev platform blog, Cloudflare domain-level rule (DEV-718) |

### [2026-04-06] Hidden pages for private integrator docs
**Status:** implemented
Expand Down Expand Up @@ -268,3 +269,15 @@ Track all redirects added to `vercel.json` here for visibility:
- Reorganise sidebar: Swap (overview), Meta-Aggregator (order-and-execute + API refs), Router (build + submit + API refs), Advanced, Routing Integration, Guides, Migration
**Rationale:** Two clear paths reduce decision fatigue. Absorbing fees and routing eliminates page-hopping for core concepts. Profile-targeted migration pages let developers find their specific upgrade path without reading irrelevant content.
**Migration notes:** Redirects added for `swap/fees` → `swap/order-and-execute`, `swap/routing` → `swap`, `swap/build/other-instructions` → `swap/build/common-instructions`.

### [2026-07-07] Changelog consolidated on the Developer Platform blog
**Status:** implemented
**Scope:** navigation | redirect
**Files affected:** `docs.json`, `changelog/index.mdx` (deleted), `AGENTS.md`/`CLAUDE.md`, `llms.txt`
**Linear issue:** DEV-595 (sub-issues DEV-717 blog backfill, DEV-718 docs redirect)

**Context:** Two changelogs existed: the docs Changelog tab (`changelog/index.mdx`) and the Developer Platform site's changelog (`developers.jup.ag/changelog`). The blog has far more visibility and sits alongside the platform, and dual-maintenance guaranteed drift.
**Decision:** The blog is the single changelog home. All docs changelog history (Jan 2025 – Jun 2026) was backfilled as one post per month (`/changelog/YYYY-MM` URLs, content in `web/content/changelog/`) in the `developer-platform` repo. The docs Changelog tab became an external `href` to `https://developers.jup.ag/changelog`, `changelog/index.mdx` was deleted, and `developers.jup.ag/docs/changelog` hard-redirects to the blog via a Cloudflare domain-level rule (same mechanism as DEVREL-133).
**Rationale:** One source of truth, more visibility, and a standardised monthly format (breaking changes first, per-product sections, "WTM" explanations, modelled on the solana_devs changelog and Linear's changelog method). The format is codified in `developer-platform` `web/content/blog/_changelog-template.mdx` and `web/content/blog/README.md`.
**Alternatives considered:** (1) Keep the docs page as a frozen archive with the tab linking out — rejected, two URLs for one concept. (2) Cross-post to both — rejected, guaranteed drift.
**Migration notes:** Existing `/updates → /changelog` redirects in `docs.json` kept (they chain into the Cloudflare rule). New changelog entries go to the `developer-platform` repo; see the Changelog section of `AGENTS.md`.
29 changes: 11 additions & 18 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,15 @@ Do the work following the Writing and Reviewing guidelines below. After writing:

#### Changelog

If your changes affect a public API or product, add a changelog entry to `updates/index.mdx`.
The changelog lives on the Developer Platform blog, NOT in this repo (decided 2026-07-07, DEV-595).
It is published as one blog post per month in the `developer-platform` repo at
`web/content/changelog/YYYY-MM.mdx`, rendered at https://developers.jup.ag/changelog.

If your changes affect a public API or product, add (or update) the current month's changelog
post in `~/Documents/Projects/developer-platform/web/content/blog/`. Follow the format in that
repo's `web/content/blog/_changelog-template.mdx` and the rules in `web/content/blog/README.md`
(breaking changes first, one section per product area, bold one-line change + "WTM" explanation
+ full docs URLs). This is a separate repo, so it means a separate PR there.

**When to add an entry:**
- New API endpoints or products
Expand All @@ -214,21 +222,6 @@ If your changes affect a public API or product, add a changelog entry to `update
- Internal refactors with no user-facing change
- Adding guides or blog posts (these are content, not changelog)

**Format:** Use the existing `<Update>` component, grouped by month (newest first):

```mdx
<Update label="March 2026" description="">
## Feature or Change Title

Brief description of what changed and what developers need to do.

- Key detail or migration step
- Link to relevant docs page
</Update>
```

Within a month, order entries by importance. Use clear headings that describe the change.

#### Capture learnings

As you work, capture reusable knowledge in `.claude/rules/` so future sessions inherit it automatically.
Expand Down Expand Up @@ -435,7 +428,7 @@ Always run/check before committing:
6. No placeholder text like "TODO" or "Lorem ipsum" left in content
7. OpenAPI spec changes in `openapi-spec/` are reflected in `api-reference/` pages
8. Images/assets added to `static/` are actually referenced somewhere
9. Changelog entry in `updates/index.mdx` if changes affect a public API or product
9. Changelog entry added to the current month's post in the `developer-platform` repo (`web/content/changelog/YYYY-MM.mdx`) if changes affect a public API or product
10. `.claude/rules/` updated if you discovered product behaviour, made IA decisions, or established conventions

## Pull Requests
Expand Down Expand Up @@ -483,7 +476,7 @@ gh pr diff
- [ ] All pages have `title`, `description`, `llmsDescription`
- [ ] `docs.json` navigation updated (if applicable)
- [ ] Redirects added (if paths changed)
- [ ] Changelog entry added to `updates/index.mdx` (if API/product change)
- [ ] Changelog entry added to the current month's post in the `developer-platform` repo (if API/product change)
- [ ] `.claude/rules/` updated with any learnings or decisions
```

Expand Down
Loading