Merge pull request #128 from objectstack-ai/copilot/write-documentation

Author: huangyiirene

README.md

@@ -248,14 +248,26 @@ This validation logic runs:
 
 ---
 
-## 📊 Implementation Progress
+## 📊 Project Status & Planning
 
-For a complete status report on ObjectQL's implementation against the documented standard protocol, see **[PROGRESS.md](./PROGRESS.md)**.
+**Current Version:** 3.0.0  
+**Overall Completion:** ~75%
 
-**Current Status:** 70% Complete (v1.8.4)
-- ✅ Core Protocol & Runtime: 85%
-- ✅ Data Drivers (SQL/Mongo): 75%
-- ⚠️ Workflow Engine: 35%
+### Key Documents
+
+- **[Roadmap](./docs/roadmap.md)** - Long-term vision, milestones, and strategic direction
+- **[Development Plan](./docs/development-plan.md)** - Detailed 6-month development plan
+- **[Project Status](./docs/project-status.md)** - Current state and metrics
+- **[Contributing Guide](./docs/contributing.md)** - How to contribute
+
+### Current Status
+
+- ✅ Core Protocol & Runtime: 90%
+- ✅ Data Drivers (SQL/Mongo/Memory/LocalStorage): 85%
+- ✅ Developer Tools (CLI, VSCode Extension): 85%
+- 🔄 Workflow Engine: 35%
+- 🔄 Security & Permissions: 70%
+- 🔄 Documentation: 75%
 
 ---
 

docs/.vitepress/config.mts

@@ -10,6 +10,15 @@ const guideSidebar = [
       { text: 'IDE Setup', link: '/guide/ide-setup' },
     ]
   },
+  {
+    text: 'Project Planning',
+    items: [
+      { text: 'Roadmap', link: '/roadmap' },
+      { text: 'Development Plan', link: '/development-plan' },
+      { text: 'Project Status', link: '/project-status' },
+      { text: 'Contributing', link: '/contributing' },
+    ]
+  },
   {
     text: 'Tutorials',
     items: [
@@ -83,6 +92,7 @@ export default defineConfig({
     // Top Navigation
     nav: [
       { text: 'Guide', link: '/guide/' },
+      { text: 'Planning', link: '/planning' },
       { text: 'AI-Native', link: '/ai/' },
       { text: 'API Reference', link: '/api/' },
       { text: 'Specification', link: '/spec/' },
@@ -98,6 +108,20 @@ export default defineConfig({
 
     // Sidebar Configuration
     sidebar: {
+      // Sidebar for Planning
+      '/planning': [
+        {
+          text: 'Project Planning',
+          items: [
+            { text: 'Overview', link: '/planning' },
+            { text: 'Roadmap', link: '/roadmap' },
+            { text: 'Development Plan', link: '/development-plan' },
+            { text: 'Project Status', link: '/project-status' },
+            { text: 'Contributing Guide', link: '/contributing' },
+          ]
+        }
+      ],
+
       // Sidebar for Tutorials
       '/tutorials/': guideSidebar,