Skip to content

Commit 941a6c6

Browse files
committed
docs: update plan to reflect completed infrastructure merge
Update plan references from phase-4-docs-clean worktree to continue-doxygen-sql-comments branch, which now contains all merged infrastructure files.
1 parent d3d4a28 commit 941a6c6

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

docs/plans/2025-10-29-documentation-release-workflow-design.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ This design adds automated documentation generation and publishing to GitHub rel
7878

7979
### Mise Tasks
8080

81-
**Existing tasks** (already implemented in phase-4-docs-clean worktree):
81+
**Existing tasks** (already implemented in continue-doxygen-sql-comments branch):
8282
- `docs:validate` - Runs coverage check and validates required tags
8383
- Script: `tasks/check-doc-coverage.sh`
8484
- Script: `tasks/validate-required-tags.sh`
@@ -230,18 +230,19 @@ unzip -t release/eql-docs-*.zip
230230
1. `mise.toml` - Add `docs:package` task definition
231231
2. `.github/workflows/release-eql.yml` - Add `publish-docs` job
232232

233-
**Files to copy from phase-4-docs-clean worktree** (if not already in main):
234-
1. `Doxyfile` - Doxygen configuration
235-
2. `tasks/doxygen-filter.sh` - SQL comment filter for Doxygen
236-
3. `tasks/check-doc-coverage.sh` - Coverage validation script
237-
4. `tasks/validate-required-tags.sh` - Tag validation script
238-
5. Existing `docs:validate` and `docs:generate` task definitions in `mise.toml`
233+
**Files already merged into continue-doxygen-sql-comments** (ready to merge to main):
234+
1. `Doxyfile` - Doxygen configuration
235+
2. `tasks/doxygen-filter.sh` - SQL comment filter for Doxygen
236+
3. `tasks/check-doc-coverage.sh` - Coverage validation script
237+
4. `tasks/validate-required-tags.sh` - Tag validation script
238+
5. `docs:validate` and `docs:generate` task definitions in `mise.toml`
239239

240240
### Implementation Steps
241241

242-
1. **Merge phase-4-docs work** (if needed)
243-
- Ensure Doxyfile and validation scripts are in main branch
244-
- Ensure `docs:validate` and `docs:generate` tasks exist
242+
1. **✅ Merge phase-4-docs work** (COMPLETED)
243+
- Infrastructure merged into continue-doxygen-sql-comments branch
244+
- Doxyfile and validation scripts now present
245+
- `docs:validate` and `docs:generate` tasks added to mise.toml
245246

246247
2. **Create packaging task**
247248
- Write `tasks/docs-package.sh`
@@ -313,5 +314,6 @@ unzip -t release/eql-docs-*.zip
313314

314315
- Existing workflow: `.github/workflows/release-eql.yml`
315316
- Existing test workflow: `.github/workflows/test-eql.yml`
316-
- Phase 4 docs work: `.worktrees/phase-4-docs-clean/`
317+
- Complete docs branch: `continue-doxygen-sql-comments` (includes merged infrastructure)
317318
- Doxygen configuration: `Doxyfile`
319+
- Documentation scripts: `tasks/check-doc-coverage.sh`, `tasks/validate-required-tags.sh`

0 commit comments

Comments
 (0)