Merge pull request #49 from objectstack-ai/copilot/continue-development-based-on-roadmap

hotlong · web-flow · commit d45de1a753ef · 2026-02-09T14:30:05.000+08:00
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,71 @@
+name: Bug Report
+description: Report a bug in ObjectDocs
+title: "[Bug]: "
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to report a bug! Please fill out the information below.
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: A clear and concise description of what the bug is.
+    validations:
+      required: true
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Steps to Reproduce
+      description: Steps to reproduce the behavior.
+      placeholder: |
+        1. Run `objectdocs build`
+        2. Navigate to ...
+        3. See error
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected Behavior
+      description: What you expected to happen.
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: ObjectDocs Version
+      description: "Run `objectdocs --version` to find this."
+      placeholder: "e.g., 0.2.12"
+    validations:
+      required: true
+  - type: dropdown
+    id: package
+    attributes:
+      label: Package
+      description: Which package is affected?
+      options:
+        - "@objectdocs/cli"
+        - "@objectdocs/site"
+        - Both
+    validations:
+      required: true
+  - type: input
+    id: node-version
+    attributes:
+      label: Node.js Version
+      placeholder: "e.g., 22.x"
+  - type: dropdown
+    id: os
+    attributes:
+      label: Operating System
+      options:
+        - macOS
+        - Linux
+        - Windows
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional Context
+      description: Any other context, screenshots, or log output about the problem.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Discussions
+    url: https://github.com/objectstack-ai/objectdocs/discussions
+    about: Ask questions or start a discussion
diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml
@@ -0,0 +1,44 @@
+name: Documentation Feedback
+description: Report an issue with the documentation or suggest improvements
+title: "[Docs]: "
+labels: ["documentation"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Help us improve our documentation! Report errors, suggest additions, or request clarifications.
+  - type: dropdown
+    id: type
+    attributes:
+      label: Feedback Type
+      options:
+        - Error or Inaccuracy
+        - Missing Information
+        - Improvement Suggestion
+        - New Page Request
+        - Translation Issue
+    validations:
+      required: true
+  - type: input
+    id: page-url
+    attributes:
+      label: Page URL
+      description: Link to the page with the issue (if applicable).
+      placeholder: "https://objectdocs.com/docs/..."
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: Describe the issue or suggestion.
+    validations:
+      required: true
+  - type: textarea
+    id: suggested-change
+    attributes:
+      label: Suggested Change
+      description: If you have a specific fix or improvement in mind, describe it here.
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional Context
+      description: Any other context, screenshots, or references.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,43 @@
+name: Feature Request
+description: Suggest a new feature for ObjectDocs
+title: "[Feature]: "
+labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for suggesting a new feature! Please describe it below.
+  - type: textarea
+    id: problem
+    attributes:
+      label: Problem Statement
+      description: A clear description of the problem this feature would solve.
+      placeholder: "I'm always frustrated when..."
+    validations:
+      required: true
+  - type: textarea
+    id: solution
+    attributes:
+      label: Proposed Solution
+      description: Describe the solution you'd like.
+    validations:
+      required: true
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives Considered
+      description: Any alternative solutions or features you've considered.
+  - type: dropdown
+    id: package
+    attributes:
+      label: Related Package
+      options:
+        - "@objectdocs/cli"
+        - "@objectdocs/site"
+        - Both
+        - New package
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional Context
+      description: Any other context or screenshots about the feature request.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,23 @@
+## Description
+
+<!-- Describe your changes in detail -->
+
+## Type of Change
+
+- [ ] Bug fix
+- [ ] New feature
+- [ ] Documentation update
+- [ ] Performance improvement
+- [ ] Refactoring
+- [ ] CI/CD change
+
+## Related Issues
+
+<!-- Link related issues: Fixes #123, Closes #456 -->
+
+## Checklist
+
+- [ ] My changes follow the project's coding conventions
+- [ ] I have tested my changes locally
+- [ ] I have updated documentation as needed
+- [ ] My changes don't break existing functionality
diff --git a/content/docs/development-plan.mdx b/content/docs/development-plan.mdx
@@ -30,7 +30,7 @@ ObjectDocs is purpose-built for **GitHub-based repository documentation** with s
 | Phase | Status | Progress |
 |-------|--------|----------|
 | Phase 1: Core Platform & Deployment | ✅ Complete | ~95% |
-| Phase 2: Developer Experience | 🟡 In Progress | ~35% |
+| Phase 2: Developer Experience | 🟡 In Progress | ~50% |
 | Phase 3: Advanced Features | ⬚ Planned | ~0% |
 
 ## 📅 Development Roadmap
@@ -46,7 +46,7 @@ ObjectDocs is purpose-built for **GitHub-based repository documentation** with s
 - [x] PR preview deployments via Vercel integration (`preview.yml` workflow)
 - [x] Changesets-based versioned releases with automated NPM publishing
 - [ ] GitHub App for automated documentation syncing
-- [ ] GitHub Issues integration for documentation feedback
+- [x] GitHub Issues integration for documentation feedback
 - [ ] Branch-based documentation versioning
 
 **Implemented**:
@@ -55,6 +55,8 @@ ObjectDocs is purpose-built for **GitHub-based repository documentation** with s
 - Preview workflow (`preview.yml`) for PR preview deployments
 - Test lifecycle workflow (`test-lifecycle.yml`) for comprehensive testing
 - Link check workflow (`link-check.yml`) for content validation
+- Issue templates for bug reports, feature requests, and documentation feedback
+- Pull request template for consistent PR descriptions
 
 </Card>
 
@@ -87,11 +89,11 @@ ObjectDocs is purpose-built for **GitHub-based repository documentation** with s
 
 **Goal**: Streamline repository-to-documentation workflow
 
-- [x] Full-featured ObjectDocs CLI with 5 commands (init, dev, build, start, translate)
+- [x] Full-featured ObjectDocs CLI with 6 commands (init, dev, build, start, translate, migrate)
 - [x] Zero-config project initialization (`objectdocs init`)
 - [x] Hot-reload development server with config watching
 - [x] Static and dynamic build modes
-- [ ] Automated content migration from README files
+- [x] Automated content migration from markdown files (`objectdocs migrate`)
 - [ ] Code snippet extraction from repository files
 - [ ] API documentation generation from source code
 - [ ] Automated changelog generation from commits
@@ -102,6 +104,7 @@ ObjectDocs is purpose-built for **GitHub-based repository documentation** with s
 - `build` — Static/dynamic builds with artifact handling
 - `start` — Production server (static via `serve` or dynamic via Next.js)
 - `translate` — OpenAI-powered batch translation with `--all` flag
+- `migrate` — Convert markdown files to MDX with frontmatter generation and `meta.json` updates
 
 </Card>
 
@@ -171,9 +174,9 @@ ObjectDocs is purpose-built for **GitHub-based repository documentation** with s
 - [x] GitHub Actions for continuous deployment (CI, release, preview)
 - [x] Pull request checks and status badges
 - [x] Automated release process via Changesets
-- [ ] Automated dependency updates via Dependabot
+- [x] Automated dependency updates via Dependabot
 - [ ] Automated release notes from git tags
-- [ ] Issue templates for documentation requests
+- [x] Issue templates for documentation requests
 
 ### Content & i18n System
 - [x] Full i18n support with 6 languages (EN, CN, JA, FR, DE, ES)
@@ -197,9 +200,9 @@ ObjectDocs is purpose-built for **GitHub-based repository documentation** with s
 - [x] OpenGraph dynamic image generation
 - [x] robots.txt for search engine crawling
 - [x] LLM-optimized content routes (`llms.txt`, `llms-full.txt`)
+- [x] Structured data (JSON-LD) for search engines
 - [ ] Lighthouse score optimization (95+ target)
 - [ ] Core Web Vitals monitoring
-- [ ] Structured data for search engines
 
 ## 🚀 Deployment Architecture
 
@@ -235,10 +238,10 @@ Repository Structure:
    - Status: Complete
    - Deliverables: System design document, package overview, updated roadmap
 
-3. **Content Migration Tools (🟡 Next Up)**
-   - Target: Q2 2026
-   - Status: In Planning
-   - Deliverables: README migration, code snippet extraction, API doc generation
+3. **Content Migration Tools (✅ Complete)**
+   - Target: Q1 2026
+   - Status: Complete
+   - Deliverables: `objectdocs migrate` command for markdown-to-MDX conversion with frontmatter and meta.json support
 
 4. **Automated Changelog Generation (🟡 Planned)**
    - Target: Q2 2026
@@ -271,6 +274,7 @@ This roadmap is dynamic and will evolve based on community feedback and GitHub/V
 
 | Date | Changes | Author |
 |------|---------|--------|
+| 2026-02-09 | Added migrate CLI command, GitHub issue/PR templates, JSON-LD structured data, updated Phase 2 → 50% | Team |
 | 2026-02-09 | Re-evaluated progress: Phase 1 → 95%, added sitemap/robots.txt/SEO features, updated next phase focus | Team |
 | 2026-02-08 | Updated progress status, marked completed features, added package overview | Team |
 | 2026-01-18 | Created development roadmap focused on GitHub-Vercel integration | Team |
diff --git a/packages/cli/bin/cli.mjs b/packages/cli/bin/cli.mjs
@@ -14,6 +14,7 @@ import { registerTranslateCommand } from '../src/commands/translate.mjs';
 import { registerDevCommand } from '../src/commands/dev.mjs';
 import { registerBuildCommand } from '../src/commands/build.mjs';
 import { registerStartCommand } from '../src/commands/start.mjs';
+import { registerMigrateCommand } from '../src/commands/migrate.mjs';
 
 const cli = cac('objectdocs');
 
@@ -22,6 +23,7 @@ registerTranslateCommand(cli);
 registerDevCommand(cli);
 registerBuildCommand(cli);
 registerStartCommand(cli);
+registerMigrateCommand(cli);
 
 cli.help();
 cli.version('0.0.1');
diff --git a/packages/cli/src/commands/migrate.mjs b/packages/cli/src/commands/migrate.mjs
diff --git a/packages/site/app/[lang]/docs/[[...slug]]/page.tsx b/packages/site/app/[lang]/docs/[[...slug]]/page.tsx
diff --git a/packages/site/app/layout.tsx b/packages/site/app/layout.tsx
