Development Roadmap
ObjectDocs development plan and feature roadmap for GitHub-based documentation with Vercel deployment
ObjectDocs Development Roadmap
This document outlines the development plan and feature roadmap for ObjectDocs, a GitHub-native documentation engine optimized for Vercel deployment.
Current Version: v0.2.12 | Last Updated: 2026-02-09
🎯 Core Mission
ObjectDocs is purpose-built for GitHub-based repository documentation with seamless Vercel deployment integration. Our core objectives:
- Git-Native Workflow: Leverage GitHub's collaboration features (PRs, reviews, issues) as the primary content management system
- Zero-Config Deployment: Push to GitHub, auto-deploy to Vercel with optimal caching and CDN distribution
- Developer-First: Treat documentation as code—version controlled, peer-reviewed, and CI/CD integrated
📊 Overall Progress Summary
| Package | Version | Status |
|---|---|---|
@objectdocs/cli | v0.2.12 | ✅ Stable |
@objectdocs/site | v0.2.12 | ✅ Stable |
| Root Workspace | v1.0.0 | ✅ Active |
| Phase | Status | Progress |
|---|---|---|
| Phase 1: Core Platform & Deployment | ✅ Complete | ~95% |
| Phase 2: Developer Experience | 🟡 In Progress | ~50% |
| Phase 3: Advanced Features | ⬚ Planned | ~0% |
📅 Development Roadmap
Phase 1: Core Platform & Deployment (Q4 2025 – Q1 2026) ✅
GitHub-Native Features
Goal: Deep integration with GitHub repository workflows
- GitHub Actions workflows for automated builds and checks (CI, release, preview, test-lifecycle, link-check)
- PR preview deployments via Vercel integration (
preview.ymlworkflow) - Changesets-based versioned releases with automated NPM publishing
- GitHub App for automated documentation syncing
- GitHub Issues integration for documentation feedback
- Branch-based documentation versioning
Implemented:
- CI workflow (
ci.yml) for build validation on push/PR - Release workflow (
release.yml) with Changesets for semantic versioning - 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
Vercel Deployment Pipeline
Goal: Optimize for Vercel's edge network and build system
- Standalone output mode for Vercel/Docker support
- Production deployment automation via GitHub Actions
-
vercel.jsonconfiguration for optimal routing - Preview deployments for every PR
- Monorepo-aware build configuration
- ISR (Incremental Static Regeneration) configuration
- Edge Functions for dynamic content
- Edge Middleware for A/B testing
Implemented:
next.config.mjswith standalone output mode- Symlink-aware artifact copying for Vercel compatibility
- Both static export and dynamic (standalone) build modes
- Vercel deployment configuration in
vercel.json
Phase 2: Enhanced Developer Experience (Q1 – Q2 2026)
CLI & Automation Tools
Goal: Streamline repository-to-documentation workflow
- Full-featured ObjectDocs CLI with 6 commands (init, dev, build, start, translate, migrate)
- Zero-config project initialization (
objectdocs init) - Hot-reload development server with config watching
- Static and dynamic build modes
- 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
Implemented:
init— Copies site template, installs dependencies, configures.gitignoredev— Dev server on port 7777 withdocs.site.jsonwatching and asset syncbuild— Static/dynamic builds with artifact handlingstart— Production server (static viaserveor dynamic via Next.js)translate— OpenAI-powered batch translation with--allflagmigrate— Convert markdown files to MDX with frontmatter generation andmeta.jsonupdates
AI-Powered Documentation Assistant
Goal: Leverage AI to enhance documentation quality
- Automated translation support via OpenAI integration
- Multi-language file generation (
.cn.mdx,.ja.mdx, etc.) - CI-compatible translation with environment variables
- AI-powered search with semantic understanding
- Auto-generate documentation from code comments
- Intelligent content suggestions based on repository
- Documentation quality scoring and recommendations
Implemented:
- OpenAI API integration in
translatecommand - Support for
--allflag to translate all content - Environment variable configuration for CI pipelines
Phase 3: Collaboration & Advanced Features (Q3 2026+)
Multi-Repository Documentation Hub
Goal: Unified documentation across multiple GitHub repositories
- Cross-repository search and navigation
- Centralized documentation portal for organizations
- Repository-level access control
- Automated aggregation from multiple sources
- Unified version management across repos
Technical Plan:
- GitHub Organization API integration
- Implement repository discovery and indexing
- Support GitHub Teams for access control
- Create aggregated search index
Enterprise GitHub Features
Goal: Support GitHub Enterprise and advanced workflows
- GitHub Enterprise Server compatibility
- SAML/SSO integration via GitHub
- Fine-grained repository permissions
- Audit logging for documentation changes
- GitHub Advanced Security integration
Technical Plan:
- Support GitHub Enterprise API endpoints
- Integrate with GitHub's OIDC provider
- Use GitHub's permission model for access control
- Implement webhook-based audit trails
🔧 Technical Infrastructure
GitHub Workflow Optimization
- GitHub Actions for continuous deployment (CI, release, preview)
- Pull request checks and status badges
- Automated release process via Changesets
- Automated dependency updates via Dependabot
- Automated release notes from git tags
- Issue templates for documentation requests
Content & i18n System
- Full i18n support with 6 languages (EN, CN, JA, FR, DE, ES)
- Language-specific MDX file routing (
.en.mdx,.cn.mdx) - Pre-built UI translations for all supported languages
- Configurable default language
- AI-powered translation CLI command
Vercel Platform Features
- Standalone output mode for serverless deployment
- Search API endpoint (
/api/search) - i18n Edge Middleware for language detection and routing
- Edge Config for dynamic feature flags
- Vercel KV for caching layer
- Web Analytics integration
Performance & SEO
- React Server Components for optimal performance
- MDX static compilation
- Automatic sitemap generation
- OpenGraph dynamic image generation
- robots.txt for search engine crawling
- LLM-optimized content routes (
llms.txt,llms-full.txt) - Structured data (JSON-LD) for search engines
- Lighthouse score optimization (95+ target)
- Core Web Vitals monitoring
🚀 Deployment Architecture
Recommended Setup
Repository Structure:
├── content/ # Documentation MDX files
│ ├── docs/ # MDX pages and meta.json
│ └── docs.site.json # Site configuration
├── .github/
│ └── workflows/ # CI/CD automation
├── vercel.json # Deployment configuration
└── package.json # Root workspaceCI/CD Pipeline
- Push to GitHub → Triggers CI build validation
- PR Created → Generates preview deployment via Vercel
- Merge to main → Auto-deploys to production
- Changeset merged → Automated NPM release
🎯 Current Focus (Q1 2026)
Active Development Tasks
-
Phase 1 SEO Completion (✅ Complete)
- Target: February 2026
- Status: Complete
- Deliverables: Automatic sitemap generation, robots.txt, OpenGraph images, LLM routes
-
Design Documentation (✅ Complete)
- Target: February 2026
- Status: Complete
- Deliverables: System design document, package overview, updated roadmap
-
Content Migration Tools (✅ Complete)
- Target: Q1 2026
- Status: Complete
- Deliverables:
objectdocs migratecommand for markdown-to-MDX conversion with frontmatter and meta.json support
-
Automated Changelog Generation (🟡 Planned)
- Target: Q2 2026
- Status: In Planning
- Deliverables: Git tag-based release notes, automated changelog from commits
-
GitHub App Development (⬚ Planned)
- Target: Q3 2026
- Status: Not Started
- Deliverables: OAuth app, webhook handlers, API integration
💡 Community & Contribution
GitHub-First Collaboration
- Submit issues for feature requests and bug reports
- Create pull requests for documentation improvements
- Participate in GitHub Discussions
- Star and watch the repository for updates
Integration Examples
This roadmap is dynamic and will evolve based on community feedback and GitHub/Vercel platform updates. Track progress via our GitHub Projects board.
🔄 Changelog
| 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 |
Note: Timelines and features are subject to change based on team resources, community needs, and platform capabilities. Follow the repository for real-time updates.