Skip to content

docs: restructure documentation site for developer experience#651

Merged
hotlong merged 5 commits intomainfrom
copilot/restructure-documentation-website
Feb 12, 2026
Merged

docs: restructure documentation site for developer experience#651
hotlong merged 5 commits intomainfrom
copilot/restructure-documentation-website

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Feb 12, 2026

Restructure the documentation site from 5 overlapping sections into a clean 4-section Diátaxis layout. The concepts/ section overlapped with both getting-started/ and protocol/, and guides/ was a dumping ground mixing tutorials with cheatsheets.

Navigation: 5 → 4 sections

Before: Getting Started → Guides → Concepts → Protocol → References
After:  Getting Started → Guides → Protocol → References

Merge Concepts into Getting Started

  • New core-concepts.mdx — consolidated metadata-driven development + design principles into one page
  • Moved architecture.mdx and glossary.mdx (née terminology.mdx) into getting-started
  • Single onboarding path instead of two overlapping sections

Organize Guides

  • Moved 10 cheatsheet/reference pages into guides/cheatsheets/ subdirectory
  • Added labeled nav separators: Building, Integration, Operations
  • Redesigned guides/index.mdx with card navigation and structured tables

Redesign landing page

  • 4-section card layout: Learn / Build / Understand / Look Up
  • Streamlined quick start to single command

Cross-reference updates

  • Updated ~15 internal links from old concepts/ and cheatsheet paths
  • Fixed quick-start learning path hrefs (were relative ./ resolving incorrectly)

The old concepts/ directory remains on disk (removed from nav only) to avoid breaking any external links.


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

@vercel
Copy link
Copy Markdown

vercel bot commented Feb 12, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
objectstack-play Ready Ready Preview, Comment Feb 12, 2026 3:54pm
spec Canceled Canceled Feb 12, 2026 3:54pm

Request Review

Copilot AI and others added 4 commits February 12, 2026 15:05
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
…arted, organize guides with cheatsheets subdirectory, redesign landing page

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
…cross-references

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Copilot AI changed the title [WIP] Refactor documentation site for better developer experience docs: restructure documentation site for developer experience Feb 12, 2026
Copilot AI requested a review from hotlong February 12, 2026 15:18
@hotlong hotlong marked this pull request as ready for review February 12, 2026 15:28
Copilot AI review requested due to automatic review settings February 12, 2026 15:28
@hotlong hotlong merged commit b151b28 into main Feb 12, 2026
1 of 3 checks passed
Copilot AI review requested due to automatic review settings March 23, 2026 23:37
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