docs: add system design, packages overview, and update development roadmap with actual progress #45

Copilot · 2026-02-08T11:19:07Z

Scanned all implemented features across @objectdocs/cli and @objectdocs/site packages, updated the development roadmap to reflect actual implementation status, and wrote complete design documentation.

Updated development roadmap

Marked completed features (GitHub Actions CI/CD, PR previews, CLI commands, AI translation, i18n, standalone output, search API)
Added progress summary table: Phase 1 ~80%, Phase 2 ~30%, Phase 3 0%
Corrected timelines and status labels to match reality
Added Chinese translation (development-plan.cn.mdx)

New: System design document (`design.mdx`)

Architecture overview with package dependency graph
Core component documentation (CLI, site engine, content layer)
Build-time, runtime, and translation data flows
docs.site.json and meta.json schema reference
i18n architecture, deployment modes, CI/CD pipeline overview

New: Packages overview (`packages.mdx`)

Per-package feature status matrices (implemented vs planned)
CLI command reference with behavior details
Site engine architecture component table
Dependency tables with versions
Complete version history (v0.1.0 → v0.2.12)

Navigation

Updated meta.json to add packages and design between getting-started and components

All new documents include bilingual EN/CN versions. Build verified (22/22 pages).

💡 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.

vercel · 2026-02-08T11:19:13Z

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

Project	Deployment	Actions	Updated (UTC)
objectdocs	Ready	Preview, Comment	Feb 8, 2026 11:36am

…roadmap with progress Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

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

github-actions · 2026-02-08T11:34:05Z

🚀 Preview Deployment

This pull request will be automatically deployed to Vercel.

Preview Links

📝 Documentation: Will be available once Vercel deployment completes
🌍 Languages: English (/en/docs) and Chinese (/cn/docs)

Build Status

Check the CI workflow for build status and any errors.

Automated preview information for PR #45

github-actions · 2026-02-08T11:35:02Z

🚀 Preview Deployment

This pull request will be automatically deployed to Vercel.

Preview Links

📝 Documentation: Will be available once Vercel deployment completes
🌍 Languages: English (/en/docs) and Chinese (/cn/docs)

Build Status

Check the CI workflow for build status and any errors.

Automated preview information for PR #45

github-actions · 2026-02-08T11:35:26Z

🚀 Preview Deployment

This pull request will be automatically deployed to Vercel.

Preview Links

📝 Documentation: Will be available once Vercel deployment completes
🌍 Languages: English (/en/docs) and Chinese (/cn/docs)

Build Status

Check the CI workflow for build status and any errors.

Automated preview information for PR #45

Copilot

Pull request overview

Adds substantial new documentation describing ObjectDocs architecture and package status, and updates the roadmap to reflect current implementation progress, while wiring the new pages into the docs navigation.

Changes:

Added new docs pages: Packages Overview and System Design.
Updated Development Roadmap to mark implemented features and summarize phase progress.
Updated content/docs/meta.json to include the new pages in navigation.

Reviewed changes

Copilot reviewed 4 out of 5 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
pnpm-lock.yaml	Updates pnpm lockfile settings and platform package metadata.
content/docs/packages.mdx	New “Packages Overview” page describing CLI/site capabilities, dependencies, and version history.
content/docs/meta.json	Adds `packages` and `design` to the docs navigation order.
content/docs/development-plan.mdx	Revises roadmap phases/status to reflect implemented features and current progress.
content/docs/design.mdx	New “System Design” page documenting architecture, flows, schemas, i18n, and deployment.

Files not reviewed (1)

pnpm-lock.yaml: Language not supported

Copilot · 2026-02-08T11:40:00Z

pnpm-lock.yaml


 settings:
-  autoInstallPeers: false
+  autoInstallPeers: true


autoInstallPeers was flipped to true in the lockfile. This changes pnpm’s peer dependency resolution behavior and can produce different dependency graphs across environments; given this PR is documentation-focused, please confirm this is intentional (and ideally comes with a corresponding config change) or revert to avoid unrelated install churn.

Suggested change

autoInstallPeers: true

autoInstallPeers: false

Copilot · 2026-02-08T11:40:01Z

content/docs/packages.mdx

+description: Complete overview of ObjectDocs software packages, their features, development status, and version history.
+---
+
+import { Package, Terminal, Layout, Zap, CheckCircle, Clock } from 'lucide-react';


This MDX file imports Package and Clock from lucide-react, but they aren’t used anywhere in the document. Removing unused imports avoids unnecessary bundle work and prevents potential lint/tooling warnings.

Suggested change

import { Package, Terminal, Layout, Zap, CheckCircle, Clock } from 'lucide-react';

import { Terminal } from 'lucide-react';

Copilot · 2026-02-08T11:40:01Z

content/docs/packages.mdx

+# Quick start with the starter template
+cp -r examples/starter my-docs
+cd my-docs
+npm init @objectdocs


The quick-start snippet uses npm init @objectdocs, but this repository doesn’t contain an npm initializer package (e.g., create-objectdocs / @objectdocs/create*). If this command relies on an external published initializer, please link/name it explicitly; otherwise update the docs to use the actual CLI install/run flow (e.g., running the objectdocs init command via the published CLI package).

Suggested change

npm init @objectdocs

pnpm dlx @objectdocs/cli init

Copilot · 2026-02-08T11:40:01Z

content/docs/design.mdx

+description: Complete system design document for ObjectDocs — architecture, technical decisions, and component overview.
+---
+
+import { FileJson, Layers, Cpu, Zap, GitBranch, Package, Globe, Code } from 'lucide-react';


Several icons are imported from lucide-react but never used in this document (e.g., Cpu, Zap, GitBranch, Code). Consider removing unused imports to keep the MDX lean and avoid potential lint/bundle warnings.

Suggested change

import { FileJson, Layers, Cpu, Zap, GitBranch, Package, Globe, Code } from 'lucide-react';

import { FileJson, Layers, Package, Globe } from 'lucide-react';

Copilot · 2026-02-08T11:40:01Z

content/docs/development-plan.mdx

 ---

-import { Code, Sparkles, Globe, Shield, GitBranch, Rocket } from 'lucide-react';
+import { Code, Sparkles, Globe, Shield, GitBranch, Rocket, CheckCircle } from 'lucide-react';


GitBranch is imported from lucide-react but no longer used (the Phase 1 card now uses CheckCircle). Removing the unused import keeps the MDX clean and avoids potential tooling warnings.

Suggested change

import { Code, Sparkles, Globe, Shield, GitBranch, Rocket, CheckCircle } from 'lucide-react';

import { Code, Sparkles, Globe, Shield, Rocket, CheckCircle } from 'lucide-react';

Copilot · 2026-02-08T11:40:02Z

content/docs/meta.json

    "getting-started",
+    "packages",
+    "design",


The PR description states that all new documents include EN/CN versions and that development-plan.cn.mdx was added, but the repo currently only has English packages.mdx, design.mdx, and development-plan.mdx under content/docs/ (no corresponding .cn.mdx files). Please either add the missing Chinese translations or update the PR description/roadmap claims to match what’s actually included.

Initial plan

db1ece2

Copilot AI assigned Copilot and hotlong Feb 8, 2026

Copilot started work on behalf of hotlong February 8, 2026 11:19 View session

vercel bot had a problem deploying to Preview February 8, 2026 11:21 Failure

docs: add design document, packages overview, and update development …

54bdab9

…roadmap with progress Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

vercel bot had a problem deploying to Preview February 8, 2026 11:28 Failure

docs: finalize documentation updates

a7a2275

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

vercel bot deployed to Preview February 8, 2026 11:30 View deployment

Copilot AI changed the title ~~[WIP] Update development progress and complete design documentation~~ docs: add system design, packages overview, and update development roadmap with actual progress Feb 8, 2026

Copilot AI requested a review from hotlong February 8, 2026 11:32

Copilot finished work on behalf of hotlong February 8, 2026 11:32

删除 design.cn.mdx

99b2925

github-actions bot added documentation Improvements or additions to documentation dependencies i18n labels Feb 8, 2026

vercel bot deployed to Preview February 8, 2026 11:34 View deployment

删除 development-plan.cn.mdx

2002e23

删除 packages.cn.mdx

a5cce6a

hotlong marked this pull request as ready for review February 8, 2026 11:35

Copilot AI review requested due to automatic review settings February 8, 2026 11:35

hotlong merged commit c74b970 into main Feb 8, 2026
7 of 8 checks passed

Copilot started reviewing on behalf of hotlong February 8, 2026 11:35 View session

vercel bot deployed to Preview February 8, 2026 11:36 View deployment

Copilot AI reviewed Feb 8, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add system design, packages overview, and update development roadmap with actual progress #45

docs: add system design, packages overview, and update development roadmap with actual progress #45

Uh oh!

Copilot AI commented Feb 8, 2026 •

edited

Loading

Uh oh!

vercel bot commented Feb 8, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Feb 8, 2026

Uh oh!

github-actions bot commented Feb 8, 2026

Uh oh!

github-actions bot commented Feb 8, 2026

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 8, 2026

Uh oh!

Copilot AI Feb 8, 2026

Uh oh!

Copilot AI Feb 8, 2026

Uh oh!

Copilot AI Feb 8, 2026

Uh oh!

Copilot AI Feb 8, 2026

Uh oh!

Copilot AI Feb 8, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	import { Package, Terminal, Layout, Zap, CheckCircle, Clock } from 'lucide-react';
	import { Terminal } from 'lucide-react';

	import { FileJson, Layers, Cpu, Zap, GitBranch, Package, Globe, Code } from 'lucide-react';
	import { FileJson, Layers, Package, Globe } from 'lucide-react';

	import { Code, Sparkles, Globe, Shield, GitBranch, Rocket, CheckCircle } from 'lucide-react';
	import { Code, Sparkles, Globe, Shield, Rocket, CheckCircle } from 'lucide-react';

docs: add system design, packages overview, and update development roadmap with actual progress #45

docs: add system design, packages overview, and update development roadmap with actual progress #45

Uh oh!

Conversation

Copilot AI commented Feb 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Updated development roadmap

New: System design document (design.mdx)

New: Packages overview (packages.mdx)

Navigation

Uh oh!

vercel bot commented Feb 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Feb 8, 2026

🚀 Preview Deployment

Preview Links

Build Status

Uh oh!

github-actions bot commented Feb 8, 2026

🚀 Preview Deployment

Preview Links

Build Status

Uh oh!

github-actions bot commented Feb 8, 2026

🚀 Preview Deployment

Preview Links

Build Status

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 8, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Copilot AI commented Feb 8, 2026 •

edited

Loading

New: System design document (`design.mdx`)

New: Packages overview (`packages.mdx`)

vercel bot commented Feb 8, 2026 •

edited

Loading