Initialize basic documentation directory structure#11
Merged
huangyiirene merged 2 commits intomainfrom Jan 18, 2026
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
…components sections Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add initial document directory structure
Initialize basic documentation directory structure
Jan 18, 2026
🚀 Preview DeploymentThis pull request will be automatically deployed to Vercel. Preview Links
Build StatusCheck the CI workflow for build status and any errors. Automated preview information for PR #11 |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR establishes the foundational documentation structure for ObjectDocs by creating a hierarchical content organization with Getting Started and Components sections. It replaces the previous minimal setup that contained only a broken index.mdx with comprehensive documentation covering installation, architecture, configuration, and ObjectUI embedding capabilities.
Changes:
- Created hierarchical documentation structure with
meta.jsonnavigation files at root and section levels - Added complete Getting Started guide covering installation, architecture principles, and configuration reference
- Documented ObjectUI embedding capabilities with JSON schema examples for grids, forms, and detail views
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| content/docs/meta.json | Defines root navigation structure linking to getting-started and components sections |
| content/docs/getting-started/meta.json | Specifies page order for Getting Started section (installation → architecture → configuration) |
| content/docs/getting-started/installation.mdx | Documents prerequisites, setup steps, project structure, and build commands |
| content/docs/getting-started/architecture.mdx | Explains three-layer architecture, directory structure, and configuration-as-code philosophy |
| content/docs/getting-started/configuration.mdx | Provides complete objectdocs.json schema reference with examples for all configuration sections |
| content/docs/components/meta.json | Defines Components section structure |
| content/docs/components/objectui-embed.mdx | Documents ObjectUI component embedding with JSON schemas for grids, forms, and detail views |
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.
Scaffolds initial documentation hierarchy with Getting Started and Components sections. The existing
content/docs/contained onlyindex.mdxwith broken references to non-existent pages.Structure Created
Navigation Definition
All sidebar structure defined via
meta.jsonfiles per ObjectDocs pattern:{ "title": "Getting Started", "pages": [ "installation", "architecture", "configuration" ] }No React component modifications required for page ordering.
Content Highlights
objectdocs.jsonschema with examples for branding, i18n, layoutEach page includes proper frontmatter, Fumadocs components (Callout, Cards, Steps), and cross-references.
Screenshots
Documentation home with structured sidebar:

Components section with TOC:

Build generates 13 static pages (includes English/Chinese translations from i18n config).
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.