Skip to content

Reorganize documentation navigation for onboarding and component discovery#143

Merged
huangyiirene merged 4 commits intomainfrom
copilot/reorganize-top-menu-docs
Jan 22, 2026
Merged

Reorganize documentation navigation for onboarding and component discovery#143
huangyiirene merged 4 commits intomainfrom
copilot/reorganize-top-menu-docs

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jan 22, 2026

Documentation navigation was not optimized for developer onboarding or component browsing. Menu hierarchy buried quick start content, and components lacked a comprehensive overview page.

Changes

Navigation Hierarchy

  • Reordered top-level menu: Getting StartedComponentsConceptsAdvancedCommunity
  • Renamed "Guide" to "Getting Started", "Reference" to "Advanced" for clarity
  • Integrated Ecosystem into Advanced section

Component Gallery

  • Created /docs/components/index.mdx as component discovery hub
  • Lists all 40+ components organized by 8 categories (Basic, Form, Layout, Data Display, Feedback, Overlay, Disclosure, Complex)
  • Includes usage patterns and schema examples

Navigation Structure

Getting Started (was 4th → now 1st)
  ├─ Quick Start (prioritized)
  ├─ Installation (prioritized)
  └─ Interactive Demos

Components (was 3rd → now 2nd)
  ├─ Component Gallery (NEW)
  ├─ Basic (Text, Icon, Image, Separator, HTML)
  ├─ Form (Button, Input, Select, Checkbox, Switch, Textarea, Slider)
  └─ ...8 categories total

Advanced (renamed from "Reference")
  ├─ API Reference
  ├─ Protocol Specification
  └─ Ecosystem

Technical Details

  • All meta.json files use flat structure (Fumadocs requirement)
  • Category headers in sidebar via ---CategoryName pattern
  • No URL changes, all existing links preserved

UI Changes

New Navigation Structure
Navigation Overview

Components Section with Categories
Components Expanded

Component Gallery Landing Page
Component Gallery

Original prompt

重新规划文档的顶层菜单,方便浏览控件和方便开发者快速入门


💬 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 Jan 22, 2026

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

Project Deployment Review Updated (UTC)
objectui-docs Error Error Jan 22, 2026 2:54am
objectui-site Ready Ready Preview, Comment Jan 22, 2026 2:54am

Request Review

Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>
Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>
@vercel vercel Bot temporarily deployed to Preview – objectui-docs January 22, 2026 02:50 Inactive
Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>
@vercel vercel Bot temporarily deployed to Preview – objectui-docs January 22, 2026 02:52 Inactive
Copilot AI changed the title [WIP] Reorganize top-level menu in documentation for better accessibility Reorganize documentation navigation for onboarding and component discovery Jan 22, 2026
Copilot AI requested a review from huangyiirene January 22, 2026 02:53
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jan 22, 2026
@github-actions
Copy link
Copy Markdown
Contributor

✅ All checks passed!

  • ✅ Type check passed
  • ✅ Tests passed
  • ✅ Lint check completed

@huangyiirene huangyiirene marked this pull request as ready for review January 22, 2026 03:24
@huangyiirene huangyiirene merged commit ef3c9aa into main Jan 22, 2026
11 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants