diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 432bd465eb..f3e2fd3cfd 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -36,7 +36,7 @@ pnpm build:local # build + frontmatter validation (CI runs this too) pnpm lint:slugcheck # permalink rules ``` -- Changed a permalink or moved a page? **Add the redirect in this PR**, in the highest-numbered file of `apps/docs/redirects/{en,pt-br}/`, and list it under **URL changes and redirects** in the PR description. +- Changed a permalink or moved a page? **Add the redirect in this PR**, in the highest-numbered file of `apps/docs/redirects/{en,pt-br}/`, and list it on the redirect row of the PR checklist. - Can't update `pt-br` yourself? Create the follow-up `i18n` issue and link it in the PR checklist. ## The PR diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index fb61af6cb5..cab10de5d5 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,15 +1,26 @@ -## Summary +## What & why - +**Related issue:** +**Pages affected:** -## How to test + - +## Type of change -## URL changes and redirects +- [ ] 🆕 New content (`feat`) +- [ ] 🩹 Fix (`fix`) — typo, broken link, wrong information +- [ ] ♻️ Content update (`docs`) — rewrite, expansion, upkeep +- [ ] 🌐 Translation sync (`i18n`) +- [ ] 🏗️ Platform / structure (`refactor` / `chore`) — reviewed by UXE, no content mixed in - +## Author checklist -## Notes - - +- [ ] PR title follows `type(scope): summary` (see [GOVERNANCE.md §4](GOVERNANCE.md)) +- [ ] Frontmatter complete: `title`, `description`, `meta_tags`, `namespace`, `permalink`, `last_reviewed` +- [ ] No legacy "edge-" product names in the copy +- [ ] How-to/tutorial content includes at least one runnable, copy-paste-tested code block +- [ ] Screenshots (if any) have alt text and follow image standards +- [ ] Internal links are relative and resolve locally +- [ ] **If any permalink changed or page moved: redirect added in this PR** +- [ ] **i18n:** `pt-br` updated in this PR **or** follow-up `i18n` issue created: +- [ ] I ran `pnpm build:local` (build + frontmatter check) without errors diff --git a/.gitignore b/.gitignore index f665bc7ee8..00caa6ecd0 100644 --- a/.gitignore +++ b/.gitignore @@ -62,4 +62,7 @@ reports/ .working-files/* +# A pull request description an agent drafts for the person who opens the PR (see AGENTS.md). +/pr.md + apps/docs/src/consts.ts diff --git a/AGENTS.md b/AGENTS.md index f3acb9359b..50346e13f8 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -25,7 +25,7 @@ preferences. | `apps/docs/src/content/docs/en` · `.../pt-br` | every published page, as `.mdx` | | `apps/docs/src/nav` | the navigation trees that build the sidebars | | `apps/docs/src/pages` | routes, including the `.md` twins, `llms.txt`, and the sitemaps | -| `apps/redirects-massive/src/redirects/{en,pt-br}/doc.json` | the redirect map | +| `apps/docs/redirects/{en,pt-br}/*.json` | the redirect map, in numbered files | | `.claude/rules/webkit-*.md` · `CLAUDE.md` | the design system rules, for UI work only | ## Writing or changing a page @@ -36,8 +36,8 @@ preferences. requires `description`, `meta_tags`, `namespace`, and `permalink`, and reviewers hold you to it. `namespace` pairs a page with its translation, so the two language versions share one. - **Changing a `permalink` or moving a page requires a redirect in the same pull request**, in - `apps/redirects-massive/src/redirects/{en,pt-br}/doc.json`. A permalink change without one is - a broken build. + the highest-numbered file of `apps/docs/redirects/{en,pt-br}/`. A permalink change without one + is a broken build. - **Register a new page in a navigation tree** under `apps/docs/src/nav`, or nothing links to it and it reaches no index. - **Internal links are root-relative** (`/en/documentation/...`) and must resolve. @@ -71,10 +71,30 @@ Run a script of another app with `pnpm -F