Skip to content

docs: add reusable notice content type - #22120

Merged
sbvegan merged 1 commit into
developfrom
codex/docs-notice-content-type
Jul 30, 2026
Merged

docs: add reusable notice content type#22120
sbvegan merged 1 commit into
developfrom
codex/docs-notice-content-type

Conversation

@sbvegan

@sbvegan sbvegan commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

What changed

  • Added a reusable notice content-type contract and copy-paste template for time-bound upgrade, deprecation, and operational notices.
  • Classified notices as Diátaxis reference pages, with content_type: notice reserved for their operational purpose and lifecycle rather than treated as a fifth quadrant or composition.
  • Extended the content-type chooser and contributor landing page with notice guidance.
  • Added the notice template to documentation navigation.
  • Normalized active and archived notice frontmatter with the notice content type.

Why

Network changes need a consistent public-documentation shape that identifies affected personas, breaking changes, required actions, timing, transition behavior, verification, support, and archive handling. The reusable contract gives authors and reviewers a shared standard while keeping the existing four-quadrant Diátaxis taxonomy intact.

This work was split from #22092 so the reusable documentation model can be reviewed independently from the Upgrade 20 notice.

Verification

  • node --import tsx scripts/lint/validate-nav.ts
  • node --import tsx scripts/lint/validate-redirects.ts
  • node scripts/lint-link-policy.mjs --baseline scripts/lint-link-policy.baseline.json
  • git diff --check

Reviewer checklist

  • Confirm that a notice is correctly classified as reference content.
  • Confirm that content_type: notice is clearly distinguished from the four content-type: compositions.
  • Confirm that the required components cover authoring, review, publication, and archive needs.
  • Confirm that the template is reusable across upgrades, deprecations, and operational changes.

@mintlify

mintlify Bot commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
Optimism-Docs 🟢 Ready View Preview Jul 29, 2026, 11:55 PM

@sbvegan
sbvegan marked this pull request as ready for review July 30, 2026 00:00
@sbvegan
sbvegan requested a review from a team as a code owner July 30, 2026 00:00
@sbvegan
sbvegan added this pull request to the merge queue Jul 30, 2026
Merged via the queue into develop with commit 1f7992d Jul 30, 2026
21 checks passed
@sbvegan
sbvegan deleted the codex/docs-notice-content-type branch July 30, 2026 15:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants