Skip to content

Commit 62b38bf

Browse files
author
Marvin Zhang
committed
chore: update subproject commit reference and enhance documentation status
1 parent 94ef73b commit 62b38bf

File tree

3 files changed

+42
-23
lines changed

3 files changed

+42
-23
lines changed

docs-site

Submodule docs-site updated 41 files

specs/061-ai-assisted-spec-writing/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -219,11 +219,11 @@ Workflow becomes:
219219
### Phase 2: Update Core Docs
220220
- [x] Update "When to Use" with AI-assisted context (merged into understanding.mdx)
221221
- [x] Update "Understanding LeanSpec" with new mental models (decision framework added)
222-
- [x] Update "AI Integration" docs with authoring workflow (covered in writing-specs-with-ai.mdx)
222+
- [x] Update "AI Integration" docs with authoring workflow (covered in ai-executable-patterns.mdx)
223223
- [x] Review all docs for consistency (validated via build + validate)
224224

225225
### Phase 3: New Content (If Needed)
226-
- [x] Created dedicated "Writing Specs with AI" page (docs-site/docs/guide/usage/ai-assisted/writing-specs-with-ai.mdx)
226+
- [x] Created dedicated "Writing Specs with AI" page (docs-site/docs/guide/usage/ai-assisted/ai-executable-patterns.mdx)
227227
- [x] Added examples of AI-drafted specs and workflows
228228
- [x] Documented best practices for prompting (Do's and Don'ts)
229229
- [x] Created workflow templates (5-step process, common patterns)
@@ -239,16 +239,16 @@ Workflow becomes:
239239

240240
- [x] Docs clearly explain when to formalize intent as spec vs. just converse with AI (understanding.mdx updated with decision framework)
241241
- [x] First principles still make sense in AI-assisted context (understanding.mdx confirms they're reinforced, not replaced)
242-
- [x] New mental models are clear and actionable (Spec-as-Checkpoint, Artifact, Context defined in writing-specs-with-ai.mdx)
242+
- [x] New mental models are clear and actionable (Spec-as-Checkpoint, Artifact, Context defined in ai-executable-patterns.mdx)
243243
- [x] No contradictions between old/new framing (consistent messaging across all updated docs)
244-
- [x] Examples demonstrate AI-assisted workflow (writing-specs-with-ai.mdx has 5-step workflow + patterns)
244+
- [x] Examples demonstrate AI-assisted workflow (ai-executable-patterns.mdx has 5-step workflow + patterns)
245245
- [ ] Community understands and can apply guidance (deferred to Phase 4: user feedback)
246246

247247
**Additional Validation:**
248248
- [x] Docs build successfully (verified with `npm run build`)
249249
- [x] Spec structure validated (no new errors from our changes)
250250
- [x] All three target docs updated (understanding.mdx updated; when-to-use.mdx was merged into understanding.mdx by spec 062)
251-
- [x] New dedicated page created (guide/usage/ai-assisted/writing-specs-with-ai.mdx)
251+
- [x] New dedicated page created (guide/usage/ai-assisted/ai-executable-patterns.mdx)
252252
- [x] Sidebar navigation updated (added to "AI-Assisted Workflows" section)
253253

254254
**Success Signals (To be measured in Phase 4):**

specs/105-docs-site-enhancements/README.md

Lines changed: 36 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
status: planned
2+
status: in-progress
33
created: '2025-11-18'
44
tags: []
55
priority: medium
@@ -8,12 +8,15 @@ related:
88
- 106-ui-package-documentation
99
- 087-cli-ui-command
1010
- 035-live-specs-showcase
11-
updated_at: '2025-11-19T01:05:47.912Z'
11+
updated_at: '2025-11-19T02:47:45.348Z'
12+
transitions:
13+
- status: in-progress
14+
at: '2025-11-19T02:47:45.348Z'
1215
---
1316

1417
# Documentation Site Optimization and Enhancements
1518

16-
> **Status**: 🗓️ Planned · **Priority**: Medium · **Created**: 2025-11-18
19+
> **Status**: ⏳ In progress · **Priority**: Medium · **Created**: 2025-11-18
1720
1821
**Project**: lean-spec
1922
**Team**: Core Development
@@ -138,6 +141,22 @@ This spec addresses comprehensive improvements to the documentation site based o
138141
- Improve existing translations
139142
- Verify completeness
140143

144+
## Status Update · 2025-11-19
145+
146+
**Completed so far**
147+
- Navigation restructure (`docs-site/sidebars.ts`) now surfaces Migration, Core Concepts, and AI-Assisted content in the intended beginner → advanced order.
148+
- `docs-site/docs/guide/understanding-leanspec.mdx` (and the zh-Hans translation) fully replaces the old "Understanding Specs" doc with deeper rationale and working-memory guidance.
149+
- Terminology was consolidated: sub-spec coverage folded into `guide/terminology/spec.mdx`, and the new `guide/terminology/built-in-metadata.mdx` (plus zh-Hans) replaces the individual status/dependency/tag pages.
150+
- Examples landing doc renamed to `examples/overview.mdx` (and translated) so the sidebar no longer points at an `index` placeholder.
151+
- Validation guidance (`docs-site/docs/guide/usage/project-management/validation.mdx`) now speaks in token thresholds rather than line counts, keeping the docs consistent with the CLI's token tooling.
152+
153+
**Still outstanding / next focus**
154+
- Phase 1 audit tasks haven’t started (global line→token sweep, Usage/Reference inventory, translation gap list).
155+
- Usage + Reference sections still need to be re-validated against the current CLI outputs, and tutorials continue to reference video placeholders.
156+
- Token guidance was only updated in validation docs; the remaining advanced/FAQ pages still reference line-count limits.
157+
- Examples beyond the existing two zh-Hans files remain untranslated; Chinese landing-page tagline and "Web App" copy still need refinement.
158+
- We have not yet simplified the Introduction Overview or run a docs-site build/link check to validate the new IA.
159+
141160
## Plan
142161

143162
### Phase 1: Content Audit
@@ -149,21 +168,21 @@ This spec addresses comprehensive improvements to the documentation site based o
149168
- [ ] List all "Examples" that need Chinese translation
150169

151170
### Phase 2: Information Architecture
152-
- [ ] Update sidebars.ts for navigation restructure
171+
- [x] Update sidebars.ts for navigation restructure
153172
- [ ] Simplify "Introduction -> Overview"
154-
- [ ] Move "Migrating to LeanSpec" to top level
155-
- [ ] Rename "Understanding Specs" → "Understanding LeanSpec"
156-
- [ ] Remove "Terminology Overview" page
157-
- [ ] Restructure terminology concepts (merge Sub-Specs, consolidate metadata)
158-
- [ ] Move "AI-Assisted Workflows" up one level
159-
- [ ] Remove "Writing Specs AI Can Execute" page
160-
- [ ] Fix "Examples" default doc name
173+
- [x] Move "Migrating to LeanSpec" to top level
174+
- [x] Rename "Understanding Specs" → "Understanding LeanSpec"
175+
- [x] Remove "Terminology Overview" page
176+
- [x] Restructure terminology concepts (merge Sub-Specs, consolidate metadata)
177+
- [x] Move "AI-Assisted Workflows" up one level
178+
- [x] Remove "Writing Specs AI Can Execute" page
179+
- [x] Fix "Examples" default doc name
161180

162181
### Phase 3: Content Updates
163182
- [ ] Replace all line-count references with token-based
164183
- [ ] Update outdated "Usage" docs
165184
- [ ] Update "Reference" docs to match current CLI
166-
- [ ] Expand terminology with in-depth explanations
185+
- [x] Expand terminology with in-depth explanations
167186
- [ ] Rewrite tutorials (remove video placeholders, focus on AI-assisted)
168187
- [ ] Update code examples and command outputs
169188

@@ -184,11 +203,11 @@ This spec addresses comprehensive improvements to the documentation site based o
184203

185204
### Navigation & Structure
186205
- [ ] Introduction section is concise and intuitive for new users
187-
- [ ] "Migrating to LeanSpec" appears at top level beside Roadmap
188-
- [ ] "Understanding LeanSpec" (renamed) appears in Core Concepts
189-
- [ ] Terminology concepts are properly organized and consolidated
190-
- [ ] "AI-Assisted Workflows" is at correct hierarchy level
191-
- [ ] Examples section has proper default doc name (not "index")
206+
- [x] "Migrating to LeanSpec" appears at top level beside Roadmap
207+
- [x] "Understanding LeanSpec" (renamed) appears in Core Concepts
208+
- [x] Terminology concepts are properly organized and consolidated
209+
- [x] "AI-Assisted Workflows" is at correct hierarchy level
210+
- [x] Examples section has proper default doc name (not "index")
192211

193212
### Content Accuracy
194213
- [ ] No line-count references remain (all token-based)

0 commit comments

Comments
 (0)