Skip to content

Commit 6873c11

Browse files
Copilothotlong
andcommitted
docs: update development roadmap with new progress
- Mark content migration tools as complete (migrate CLI command) - Mark issue templates and dependabot as complete - Mark structured data for search engines as complete - Update Phase 2 progress to ~50% - Add changelog entry for latest developments Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent f3946d8 commit 6873c11

1 file changed

Lines changed: 15 additions & 11 deletions

File tree

content/docs/development-plan.mdx

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ ObjectDocs is purpose-built for **GitHub-based repository documentation** with s
3030
| Phase | Status | Progress |
3131
|-------|--------|----------|
3232
| Phase 1: Core Platform & Deployment | ✅ Complete | ~95% |
33-
| Phase 2: Developer Experience | 🟡 In Progress | ~35% |
33+
| Phase 2: Developer Experience | 🟡 In Progress | ~50% |
3434
| Phase 3: Advanced Features | ⬚ Planned | ~0% |
3535

3636
## 📅 Development Roadmap
@@ -46,7 +46,7 @@ ObjectDocs is purpose-built for **GitHub-based repository documentation** with s
4646
- [x] PR preview deployments via Vercel integration (`preview.yml` workflow)
4747
- [x] Changesets-based versioned releases with automated NPM publishing
4848
- [ ] GitHub App for automated documentation syncing
49-
- [ ] GitHub Issues integration for documentation feedback
49+
- [x] GitHub Issues integration for documentation feedback
5050
- [ ] Branch-based documentation versioning
5151

5252
**Implemented**:
@@ -55,6 +55,8 @@ ObjectDocs is purpose-built for **GitHub-based repository documentation** with s
5555
- Preview workflow (`preview.yml`) for PR preview deployments
5656
- Test lifecycle workflow (`test-lifecycle.yml`) for comprehensive testing
5757
- Link check workflow (`link-check.yml`) for content validation
58+
- Issue templates for bug reports, feature requests, and documentation feedback
59+
- Pull request template for consistent PR descriptions
5860

5961
</Card>
6062

@@ -87,11 +89,11 @@ ObjectDocs is purpose-built for **GitHub-based repository documentation** with s
8789

8890
**Goal**: Streamline repository-to-documentation workflow
8991

90-
- [x] Full-featured ObjectDocs CLI with 5 commands (init, dev, build, start, translate)
92+
- [x] Full-featured ObjectDocs CLI with 6 commands (init, dev, build, start, translate, migrate)
9193
- [x] Zero-config project initialization (`objectdocs init`)
9294
- [x] Hot-reload development server with config watching
9395
- [x] Static and dynamic build modes
94-
- [ ] Automated content migration from README files
96+
- [x] Automated content migration from markdown files (`objectdocs migrate`)
9597
- [ ] Code snippet extraction from repository files
9698
- [ ] API documentation generation from source code
9799
- [ ] Automated changelog generation from commits
@@ -102,6 +104,7 @@ ObjectDocs is purpose-built for **GitHub-based repository documentation** with s
102104
- `build` — Static/dynamic builds with artifact handling
103105
- `start` — Production server (static via `serve` or dynamic via Next.js)
104106
- `translate` — OpenAI-powered batch translation with `--all` flag
107+
- `migrate` — Convert markdown files to MDX with frontmatter generation and `meta.json` updates
105108

106109
</Card>
107110

@@ -171,9 +174,9 @@ ObjectDocs is purpose-built for **GitHub-based repository documentation** with s
171174
- [x] GitHub Actions for continuous deployment (CI, release, preview)
172175
- [x] Pull request checks and status badges
173176
- [x] Automated release process via Changesets
174-
- [ ] Automated dependency updates via Dependabot
177+
- [x] Automated dependency updates via Dependabot
175178
- [ ] Automated release notes from git tags
176-
- [ ] Issue templates for documentation requests
179+
- [x] Issue templates for documentation requests
177180

178181
### Content & i18n System
179182
- [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
197200
- [x] OpenGraph dynamic image generation
198201
- [x] robots.txt for search engine crawling
199202
- [x] LLM-optimized content routes (`llms.txt`, `llms-full.txt`)
203+
- [x] Structured data (JSON-LD) for search engines
200204
- [ ] Lighthouse score optimization (95+ target)
201205
- [ ] Core Web Vitals monitoring
202-
- [ ] Structured data for search engines
203206

204207
## 🚀 Deployment Architecture
205208

@@ -235,10 +238,10 @@ Repository Structure:
235238
- Status: Complete
236239
- Deliverables: System design document, package overview, updated roadmap
237240

238-
3. **Content Migration Tools (🟡 Next Up)**
239-
- Target: Q2 2026
240-
- Status: In Planning
241-
- Deliverables: README migration, code snippet extraction, API doc generation
241+
3. **Content Migration Tools (✅ Complete)**
242+
- Target: Q1 2026
243+
- Status: Complete
244+
- Deliverables: `objectdocs migrate` command for markdown-to-MDX conversion with frontmatter and meta.json support
242245

243246
4. **Automated Changelog Generation (🟡 Planned)**
244247
- Target: Q2 2026
@@ -271,6 +274,7 @@ This roadmap is dynamic and will evolve based on community feedback and GitHub/V
271274

272275
| Date | Changes | Author |
273276
|------|---------|--------|
277+
| 2026-02-09 | Added migrate CLI command, GitHub issue/PR templates, JSON-LD structured data, updated Phase 2 → 50% | Team |
274278
| 2026-02-09 | Re-evaluated progress: Phase 1 → 95%, added sitemap/robots.txt/SEO features, updated next phase focus | Team |
275279
| 2026-02-08 | Updated progress status, marked completed features, added package overview | Team |
276280
| 2026-01-18 | Created development roadmap focused on GitHub-Vercel integration | Team |

0 commit comments

Comments
 (0)