Skip to content

docs(site): give the upgrade pages their own Upgrading section - #2259

Merged
clay-good merged 1 commit into
mainfrom
claude/docs-upgrading-section
Nov 17, 2026
Merged

clay-good merged 1 commit into
mainfrom
claude/docs-upgrading-section

Conversation

@clay-good

@clay-good clay-good commented Nov 17, 2026 •

Copy link
Copy Markdown
Collaborator

Status: Ready to merge once CI is green. Docs only.

What was missing

The two upgrade pages sat in Start, between Quickstart and Customize. Start is the path for someone new to OpenSpec, and upgrade pages are for people who already use it. They were there only because the Help section they belong to is not published yet.

What it does

The upgrade pages get their own section at the end of the sidebar, newest first. The 2.1 page is now titled like the 2.0 one.

Start
  Installation
  Set up your project
  Quickstart
Customize
Multi-repo (beta)
Reference
Upgrading
  Upgrade to 2.1
  Upgrade to 2.0
Before After
Sidebar section Start Upgrading
2.1 page title Upgrade to 2.1: global skills Upgrade to 2.1
URLs /docs/upgrade-2-1, /docs/upgrade-to-2 Unchanged

Proof it works

  • The website builds, and the built 2.1 page shows the sidebar in the order above.
  • The docs tests pass (10 files, 38 tests).

Notes

  • Links in the release notes and the changelog keep working, since no URL changed.
  • The 2.1 page keeps its one-line description, which still says the release is about global skills.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Renamed the “Upgrade to 2.1: global skills” guide to “Upgrade to 2.1.”
    • Moved the upgrade guides from the Start section to a dedicated Upgrading section.

The two upgrade pages sat in Start, between Quickstart and Customize,
because the Help section they belong to is not published yet. They now
have their own section at the end of the sidebar, newest first, and the
2.1 page is titled like the 2.0 one. URLs are unchanged.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Nov 17, 2026 •

Copy link
Copy Markdown

Deploying openspec-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 7b73e2a
Status: ✅  Deploy successful!
Preview URL: https://d156bb76.openspec-docs.pages.dev
Branch Preview URL: https://claude-docs-upgrading-sectio.openspec-docs.pages.dev

View logs

@clay-good
clay-good requested review from a team and TabishB as code owners November 17, 2026 01:42
@coderabbitai

coderabbitai Bot commented Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The documentation index now lists both upgrade pages under Upgrading. The 2.1 page label and heading no longer include “global skills.” The sync configuration lists the 2.1 upgrade page before the 2.0 page.

Changes: Upgrade documentation

Layer / File(s) Summary
Update upgrade page navigation and titles
website/docs.sync.config.mjs, docs-lab/README.md, docs-lab/help/upgrade-to-2-1.md
The sync configuration moves both upgrade pages from Start to Upgrading and lists the 2.1 page first. The index labels both pages under Upgrading, and the 2.1 label and heading drop “global skills.”

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Merge Risk: Minimal · up to 7b73e

This moves the upgrade pages into a new Upgrading sidebar section and shortens the 2.1 page title. The URLs stay the same. No actionable merge risk was found; CI should be green before merging.

Pre-merge checks: Passed 4

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title "docs(site): give the upgrade pages their own Upgrading section" matches the main change. The PR moves the two upgrade pages out of the Start section into a new Upgrading section at the end …
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title "docs(site): give the upgrade pages their own Upgrading section" matches the main change. The PR moves the two upgrade pages out of the Start section into a new Upgrading section at the end of the sidebar. The title names the site docs scope and the new section, which are both present in the changeset. The title does not cover the 2.1 page title change or the newest-first order, but those are secondary details.

Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Warning

Some tools did not complete. Review the errors below.

ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint install failed: package-manager metadata or lockfile failed a supply-chain integrity policy. Refresh the packageManager pin and lockfile locally.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

Commits

Reviewing files that changed from the base of the PR and between 8bd4b35 and 7b73e2a.

Files selected for processing: 3

  • docs-lab/README.md
  • docs-lab/help/upgrade-to-2-1.md
  • website/docs.sync.config.mjs

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 9 remain after this review.

@openspec-cloud

Copy link
Copy Markdown
Contributor

No PR-relevant drift confirmed.

AI-generated · A citation proves the line exists, not that it makes the case — verify before acting.
No issue was confirmed at 7b73e2a; 2 requirements could not be verified.
This is not a full-repository clean result; see the check for coverage and any broader findings.
View results · Click Refresh, then Scan again in the check. Or comment /openspec-cloud.

@clay-good
clay-good added this pull request to the merge queue Nov 17, 2026
Merged via the queue into main with commit f085c85 Nov 17, 2026
24 checks passed
@clay-good
clay-good deleted the claude/docs-upgrading-section branch November 17, 2026 01:49
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