Restructure documentation following industry best practices#67
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
- Add Quick Start section with role-based guides - Add Tutorials landing page - Add FAQ and Troubleshooting sections - Add index pages for all specification sections - Improve navigation hierarchy - Update main index with new sections Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Remove unsupported Tabs/Tab components and use simple section headers instead. Build now completes successfully. Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Optimize documentation structure for best practices
Restructure documentation following industry best practices
Jan 22, 2026
github-actions
bot
added
documentation
Contributor
|
This PR is very large. Consider breaking it into smaller PRs for easier review. |
hotlong
approved these changes
Jan 22, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR restructures the documentation to follow industry best practices, implementing progressive disclosure and role-based onboarding patterns inspired by React, Stripe, and Kubernetes documentation.
Changes:
- Introduced Quick Start section with 4 role-based learning paths (backend developers, frontend developers, architects, and a 10-minute tutorial)
- Added Tutorials framework with categorized hands-on guides and learning paths
- Created FAQ and Troubleshooting sections for better self-service support
- Enhanced Specifications with index pages providing clear navigation and protocol versioning information
Reviewed changes
Copilot reviewed 21 out of 21 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| content/docs/meta.json | Added new top-level sections (quick-start, tutorials, faq, troubleshooting) to documentation navigation |
| content/docs/index.mdx | Updated landing page to feature new Quick Start and Tutorials sections alongside existing documentation |
| content/docs/quick-start.mdx | New role selector page introducing ObjectStack and directing users to appropriate learning paths |
| content/docs/quick-start/build-first-app.mdx | Complete 10-minute tutorial for building a task management application |
| content/docs/quick-start/backend-developers.mdx | Backend-focused introduction covering data modeling, business logic, and API generation |
| content/docs/quick-start/frontend-developers.mdx | Frontend-focused introduction covering UI configuration and server-driven UI concepts |
| content/docs/quick-start/architects.mdx | Architecture deep dive covering design philosophy, industry comparisons, and technical decisions |
| content/docs/tutorials.mdx | Tutorial framework index with categorized learning paths and progression guidance |
| content/docs/faq.mdx | Comprehensive FAQ covering general, technical, development, and business questions |
| content/docs/troubleshooting.mdx | Debugging guide with common issues and solutions across installation, runtime, and development |
| content/docs/specifications/index.mdx | Protocol specifications overview with versioning information and audience guidance |
| content/docs/specifications/data/index.mdx | Data protocol (ObjectQL) overview and navigation hub |
| content/docs/specifications/ui/index.mdx | UI protocol (ObjectUI) overview and navigation hub |
| content/docs/specifications/server/index.mdx | System protocol (ObjectOS) overview and navigation hub |
Comments suppressed due to low confidence (1)
content/docs/troubleshooting.mdx:1
- This creates a circular reference - the troubleshooting guide is linking to itself at /docs/guides/troubleshooting instead of the correct path /docs/troubleshooting.
---
| ## Get Help | ||
|
|
||
| Stuck on a tutorial? | ||
| - Check the [Troubleshooting Guide](/docs/guides/troubleshooting) |
There was a problem hiding this comment.
The troubleshooting guide link points to /docs/guides/troubleshooting but the actual file is at /docs/troubleshooting.
Suggested change
| - Check the [Troubleshooting Guide](/docs/guides/troubleshooting) | |
| - Check the [Troubleshooting Guide](/docs/troubleshooting) |
| Stuck on a tutorial? | ||
| - Check the [Troubleshooting Guide](/docs/guides/troubleshooting) | ||
| - Ask in [GitHub Discussions](https://github.com/objectstack-ai/spec/discussions) | ||
| - Review the [FAQ](/docs/guides/faq) |
There was a problem hiding this comment.
The FAQ link points to /docs/guides/faq but the actual file is at /docs/faq.
Suggested change
| - Review the [FAQ](/docs/guides/faq) | |
| - Review the [FAQ](/docs/faq) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation lacked progressive disclosure and role-based onboarding. Structure did not follow patterns from React, Stripe, Kubernetes docs.
Changes
New Sections
/docs/quick-start) - 4 role-based paths (backend, frontend, architect, tutorial)/docs/tutorials) - Learning path framework with categorized hands-on guides/docs/faq) - 20+ common questions/docs/troubleshooting) - Debugging guide with solutionsEnhanced Navigation
quick-start → tutorials → guides → concepts → specifications → referencesContent Examples
Role-based quick start pattern:
Specification index structure:
Structure Change
Files: +21 created, 7 updated. Builds successfully (588 static pages).
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.