Skip to content

Commit 7c6dac7

Browse files
authored
Merge pull request #48 from objectstack-ai/copilot/reassess-development-plan
2 parents ea889c3 + a1b5cd5 commit 7c6dac7

File tree

4 files changed

+68
-16
lines changed

4 files changed

+68
-16
lines changed

content/docs/development-plan.mdx

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import { Code, Sparkles, Globe, Shield, GitBranch, Rocket, CheckCircle } from 'l
99

1010
This document outlines the development plan and feature roadmap for ObjectDocs, a GitHub-native documentation engine optimized for Vercel deployment.
1111

12-
**Current Version**: v0.2.12 | **Last Updated**: 2026-02-08
12+
**Current Version**: v0.2.12 | **Last Updated**: 2026-02-09
1313

1414
## 🎯 Core Mission
1515

@@ -29,13 +29,13 @@ ObjectDocs is purpose-built for **GitHub-based repository documentation** with s
2929

3030
| Phase | Status | Progress |
3131
|-------|--------|----------|
32-
| Phase 1: Core Platform & Deployment |Mostly Complete | ~80% |
33-
| Phase 2: Developer Experience | 🟡 In Progress | ~30% |
32+
| Phase 1: Core Platform & Deployment | ✅ Complete | ~95% |
33+
| Phase 2: Developer Experience | 🟡 In Progress | ~35% |
3434
| Phase 3: Advanced Features | ⬚ Planned | ~0% |
3535

3636
## 📅 Development Roadmap
3737

38-
### Phase 1: Core Platform & Deployment (Q4 2025 – Q1 2026)
38+
### Phase 1: Core Platform & Deployment (Q4 2025 – Q1 2026)
3939

4040
<Cards>
4141
<Card icon={<CheckCircle />} title="GitHub-Native Features">
@@ -185,18 +185,20 @@ ObjectDocs is purpose-built for **GitHub-based repository documentation** with s
185185
### Vercel Platform Features
186186
- [x] Standalone output mode for serverless deployment
187187
- [x] Search API endpoint (`/api/search`)
188+
- [x] i18n Edge Middleware for language detection and routing
188189
- [ ] Edge Config for dynamic feature flags
189190
- [ ] Vercel KV for caching layer
190191
- [ ] Web Analytics integration
191-
- [ ] A/B testing with Edge Middleware
192192

193193
### Performance & SEO
194194
- [x] React Server Components for optimal performance
195195
- [x] MDX static compilation
196+
- [x] Automatic sitemap generation
197+
- [x] OpenGraph dynamic image generation
198+
- [x] robots.txt for search engine crawling
199+
- [x] LLM-optimized content routes (`llms.txt`, `llms-full.txt`)
196200
- [ ] Lighthouse score optimization (95+ target)
197201
- [ ] Core Web Vitals monitoring
198-
- [ ] Automatic sitemap generation
199-
- [ ] OpenGraph metadata automation
200202
- [ ] Structured data for search engines
201203

202204
## 🚀 Deployment Architecture
@@ -223,22 +225,27 @@ Repository Structure:
223225

224226
### Active Development Tasks
225227

226-
1. **Design Documentation (✅ Complete)**
228+
1. **Phase 1 SEO Completion (✅ Complete)**
229+
- Target: February 2026
230+
- Status: Complete
231+
- Deliverables: Automatic sitemap generation, robots.txt, OpenGraph images, LLM routes
232+
233+
2. **Design Documentation (✅ Complete)**
227234
- Target: February 2026
228235
- Status: Complete
229236
- Deliverables: System design document, package overview, updated roadmap
230237

231-
2. **ISR & Edge Functions (🟡 In Progress)**
232-
- Target: March 2026
238+
3. **Content Migration Tools (🟡 Next Up)**
239+
- Target: Q2 2026
233240
- Status: In Planning
234-
- Deliverables: ISR configuration, edge middleware, caching strategy
241+
- Deliverables: README migration, code snippet extraction, API doc generation
235242

236-
3. **Content Migration Tools (🟡 Planned)**
243+
4. **Automated Changelog Generation (🟡 Planned)**
237244
- Target: Q2 2026
238245
- Status: In Planning
239-
- Deliverables: README migration, code snippet extraction, API doc generation
246+
- Deliverables: Git tag-based release notes, automated changelog from commits
240247

241-
4. **GitHub App Development (⬚ Planned)**
248+
5. **GitHub App Development (⬚ Planned)**
242249
- Target: Q3 2026
243250
- Status: Not Started
244251
- Deliverables: OAuth app, webhook handlers, API integration
@@ -264,6 +271,7 @@ This roadmap is dynamic and will evolve based on community feedback and GitHub/V
264271

265272
| Date | Changes | Author |
266273
|------|---------|--------|
274+
| 2026-02-09 | Re-evaluated progress: Phase 1 → 95%, added sitemap/robots.txt/SEO features, updated next phase focus | Team |
267275
| 2026-02-08 | Updated progress status, marked completed features, added package overview | Team |
268276
| 2026-01-18 | Created development roadmap focused on GitHub-Vercel integration | Team |
269277

packages/site/app/robots.ts

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
/**
2+
* ObjectDocs
3+
* Copyright (c) 2026-present ObjectStack Inc.
4+
*
5+
* This source code is licensed under the MIT license found in the
6+
* LICENSE file in the root directory of this source tree.
7+
*/
8+
9+
import type { MetadataRoute } from 'next';
10+
import { siteConfig } from '@/lib/site-config';
11+
12+
export default function robots(): MetadataRoute.Robots {
13+
const url = siteConfig.meta.url;
14+
15+
return {
16+
rules: {
17+
userAgent: '*',
18+
allow: '/',
19+
disallow: ['/api/', '/_next/'],
20+
},
21+
sitemap: `${url}/sitemap.xml`,
22+
};
23+
}

packages/site/app/sitemap.ts

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
/**
2+
* ObjectDocs
3+
* Copyright (c) 2026-present ObjectStack Inc.
4+
*
5+
* This source code is licensed under the MIT license found in the
6+
* LICENSE file in the root directory of this source tree.
7+
*/
8+
9+
import type { MetadataRoute } from 'next';
10+
import { source } from '@/lib/source';
11+
import { siteConfig } from '@/lib/site-config';
12+
13+
export default function sitemap(): MetadataRoute.Sitemap {
14+
const url = siteConfig.meta.url;
15+
16+
return source.getPages().map((page) => ({
17+
url: `${url}${page.url}`,
18+
changeFrequency: 'weekly',
19+
priority: page.url.endsWith('/docs') ? 1.0 : 0.7,
20+
}));
21+
}

packages/site/middleware.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,6 @@ export default function middleware(request: NextRequest, event: NextFetchEvent)
3939
}
4040

4141
export const config = {
42-
// Matcher ignoring `/_next/`, `/api/`, LLM routes, and OG image routes
43-
matcher: ['/((?!api|_next/static|_next/image|favicon.ico|logo.svg|llms\\.txt|llms-full\\.txt|llms\\.mdx|og/).*)'],
42+
// Matcher ignoring `/_next/`, `/api/`, LLM routes, OG image routes, and SEO files
43+
matcher: ['/((?!api|_next/static|_next/image|favicon.ico|logo.svg|llms\\.txt|llms-full\\.txt|llms\\.mdx|og/|sitemap\\.xml|robots\\.txt).*)'],
4444
};

0 commit comments

Comments
 (0)