Skip to content

Consolidate documentation to /content/docs#260

Merged
hotlong merged 2 commits intomainfrom
copilot/refactor-fumadocs-website-content
Feb 12, 2026
Merged

Consolidate documentation to /content/docs#260
hotlong merged 2 commits intomainfrom
copilot/refactor-fumadocs-website-content

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Feb 12, 2026

Documentation was fragmented across /docs (24 MD files) and /apps/site/content/docs (18 MDX files). Consolidated to single source at repository root /content/docs for cleaner monorepo structure and easier maintenance.

Changes

  • Merged documentation sources: Combined /docs and /apps/site/content/docs into /content/docs (32 MDX files total)
  • Standardized format: Converted all Markdown to MDX with proper YAML frontmatter
  • Added ADR section: Architecture Decision Records now discoverable in navigation
  • Expanded guide navigation: Added 7 previously unlisted pages (quickstart, cli-usage, api-reference, plugin-development, migration-from-kernel, troubleshooting, technical-debt-resolution)
  • Updated fumadocs config: apps/site/source.config.ts now references ../../content/docs
  • Removed legacy paths: Deleted /docs and /apps/site/content/docs

Structure

/content/docs/
├── adr/              # Architecture Decision Records
├── getting-started/  # Installation & quick start
├── guide/           # 18 comprehensive guides
├── spec/            # Protocol specifications
└── meta.json        # Navigation hierarchy

All pages build successfully and maintain existing navigation structure.

Original prompt

重构 fumadocs 官网文档网站和首页,内容应该位于 /content/docs ,目前的 /docs, /apps/site/content/docs 内容重构清理整理合并到 /content/docs

The user has attached the following file paths as relevant context:

  • .github/copilot-instructions.md
  • .github/copilot-instructions.md
  • .github/copilot-instructions.md

Created from VS Code.


💬 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)
objectos Ready Ready Preview, Comment Feb 12, 2026 2:56pm
objectos-demo Error Error Feb 12, 2026 2:56pm

Request Review

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Copilot AI changed the title [WIP] Refactor Fumadocs website documentation and homepage Consolidate documentation to /content/docs Feb 12, 2026
Copilot AI requested a review from hotlong February 12, 2026 14:10
@hotlong hotlong marked this pull request as ready for review February 12, 2026 14:15
Copilot AI review requested due to automatic review settings February 12, 2026 14:15
@hotlong hotlong merged commit 5893072 into main Feb 12, 2026
5 of 7 checks passed
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR consolidates ObjectOS documentation into a single source of truth under /content/docs, updates the Fumadocs site to read from that directory, and removes the legacy /docs and apps/site/content/docs sources to simplify maintenance.

Changes:

  • Migrated legacy Markdown docs into /content/docs as MDX with frontmatter + new navigation meta.json files.
  • Updated apps/site/source.config.ts to load docs from ../../content/docs.
  • Removed legacy documentation files under /docs and legacy meta files under apps/site/content/docs.

Reviewed changes

Copilot reviewed 33 out of 52 changed files in this pull request and generated no comments.

Show a summary per file
File Description
apps/site/source.config.ts Points Fumadocs to the consolidated /content/docs directory and simplifies transformer config.
apps/site/content/docs/meta.json Removes legacy docs navigation meta file (old docs source).
apps/site/content/docs/spec/meta.json Removes legacy spec navigation meta file (old docs source).
content/docs/meta.json Adds top-level consolidated documentation navigation.
content/docs/index.mdx Updates docs landing page content (removes Card components in favor of links).
content/docs/spec/meta.json Adds consolidated “Specifications” navigation.
content/docs/spec/index.mdx Adds consolidated spec index page.
content/docs/spec/metadata-format.mdx Adds consolidated metadata format specification (MDX + frontmatter).
content/docs/spec/query-language.mdx Adds consolidated query language specification (MDX + frontmatter).
content/docs/spec/http-protocol.mdx Adds consolidated HTTP protocol specification (MDX + frontmatter).
content/docs/adr/meta.json Adds ADR section navigation.
content/docs/adr/index.mdx Adds ADR index page.
content/docs/adr/001-vitest-standardization.mdx Converts ADR to MDX frontmatter format.
content/docs/getting-started/meta.json Adds “Getting Started” section navigation.
content/docs/getting-started/index.mdx Adds “Getting Started” landing page.
content/docs/getting-started/installation.mdx Adds installation instructions under the new structure.
content/docs/guide/meta.json Expands guide navigation to include additional pages.
content/docs/guide/index.mdx Adds consolidated guide index page (MDX + frontmatter).
content/docs/guide/data-modeling.mdx Adds consolidated data modeling guide (MDX + frontmatter).
content/docs/guide/logic-hooks.mdx Adds consolidated logic hooks guide (MDX + frontmatter).
content/docs/guide/logic-actions.mdx Adds consolidated logic actions guide (MDX + frontmatter).
content/docs/guide/platform-components.mdx Adds consolidated platform components guide (MDX + frontmatter).
content/docs/guide/ui-framework.mdx Adds consolidated UI framework reference (MDX + frontmatter).
content/docs/guide/contributing-development.mdx Adds consolidated contributing guide (MDX + frontmatter).
content/docs/guide/api-reference.mdx Updates existing guide page to MDX frontmatter format.
content/docs/guide/cli-usage.mdx Updates existing guide page to MDX frontmatter format.
content/docs/guide/plugin-development.mdx Updates existing guide page to MDX frontmatter format.
content/docs/guide/migration-from-kernel.mdx Updates existing guide page to MDX frontmatter format.
content/docs/guide/quickstart.mdx Updates existing guide page to MDX frontmatter format.
content/docs/guide/troubleshooting.mdx Updates existing guide page to MDX frontmatter format.
content/docs/guide/technical-debt-resolution.mdx Updates existing guide page to MDX frontmatter format.
docs/index.md Removes legacy docs home page.
docs/public/logo.svg Removes legacy docs logo asset.
docs/spec/index.md Removes legacy spec index.
docs/spec/metadata-format.md Removes legacy metadata spec.
docs/spec/query-language.md Removes legacy query language spec.
docs/spec/http-protocol.md Removes legacy HTTP protocol spec.
docs/guide/index.md Removes legacy guide index.
docs/guide/data-modeling.md Removes legacy data modeling guide.
docs/guide/logic-hooks.md Removes legacy logic hooks guide.
docs/guide/logic-actions.md Removes legacy logic actions guide.
docs/guide/ui-framework.md Removes legacy UI framework guide.
docs/guide/security-guide.md Removes legacy security guide.
docs/guide/sdk-reference.md Removes legacy SDK reference.
docs/guide/platform-components.md Removes legacy platform components doc.
docs/guide/development-plan.md Removes legacy development plan doc.
docs/guide/contributing-development.md Removes legacy contributing doc.

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.

3 participants