chore(conductor): Add new track 'Update documentation and cleanup MainContext.md'
This commit is contained in:
@@ -22,3 +22,8 @@ This file tracks all major tracks for the project. Each track has its own detail
|
||||
|
||||
- [ ] **Track: Move discussion histories to their own toml to prevent the ai agent from reading it (will be on a blacklist).**
|
||||
*Link: [./tracks/history_segregation_20260224/](./tracks/history_segregation_20260224/)*
|
||||
|
||||
---
|
||||
|
||||
- [ ] **Track: Update ./docs/* & ./Readme.md, review ./MainContext.md significance (should we keep it..).**
|
||||
*Link: [./tracks/documentation_refresh_20260224/](./tracks/documentation_refresh_20260224/)*
|
||||
|
||||
5
conductor/tracks/documentation_refresh_20260224/index.md
Normal file
5
conductor/tracks/documentation_refresh_20260224/index.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# Track documentation_refresh_20260224 Context
|
||||
|
||||
- [Specification](./spec.md)
|
||||
- [Implementation Plan](./plan.md)
|
||||
- [Metadata](./metadata.json)
|
||||
@@ -0,0 +1,8 @@
|
||||
{
|
||||
"track_id": "documentation_refresh_20260224",
|
||||
"type": "chore",
|
||||
"status": "new",
|
||||
"created_at": "2026-02-24T18:35:00Z",
|
||||
"updated_at": "2026-02-24T18:35:00Z",
|
||||
"description": "Update ./docs/* & ./Readme.md, review ./MainContext.md significance (should we keep it..)."
|
||||
}
|
||||
34
conductor/tracks/documentation_refresh_20260224/plan.md
Normal file
34
conductor/tracks/documentation_refresh_20260224/plan.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# Implementation Plan: Documentation Refresh and Context Cleanup
|
||||
|
||||
This plan follows the project's standard task workflow to modernize documentation and decommission redundant context files.
|
||||
|
||||
## Phase 1: Context Cleanup
|
||||
Permanently remove redundant files and update project-wide references.
|
||||
|
||||
- [ ] Task: Audit references to `MainContext.md` across the project.
|
||||
- [ ] Task: Write failing test that verifies the absence of `MainContext.md` and related broken links.
|
||||
- [ ] Task: Delete `MainContext.md` and update any identified references.
|
||||
- [ ] Task: Verify that all internal links remain functional.
|
||||
- [ ] Task: Conductor - User Manual Verification 'Context Cleanup' (Protocol in workflow.md)
|
||||
|
||||
## Phase 2: Core Documentation Refresh
|
||||
Update the Architecture and Tools guides to reflect recent architectural changes.
|
||||
|
||||
- [ ] Task: Audit `docs/guide_architecture.md` against current code (e.g., `EventEmitter`, `ApiHookClient`, Conductor).
|
||||
- [ ] Task: Update `docs/guide_architecture.md` with current Conductor-driven architecture and dual-GUI structure.
|
||||
- [ ] Task: Audit `docs/guide_tools.md` for toolset accuracy.
|
||||
- [ ] Task: Update `docs/guide_tools.md` to include API hook client and performance monitoring documentation.
|
||||
- [ ] Task: Verify documentation alignment with actual implementation.
|
||||
- [ ] Task: Conductor - User Manual Verification 'Core Documentation Refresh' (Protocol in workflow.md)
|
||||
|
||||
## Phase 3: README Refresh and Link Validation
|
||||
Modernize the primary project entry point and ensure documentation integrity.
|
||||
|
||||
- [ ] Task: Audit `Readme.md` for accuracy of setup instructions and feature highlights.
|
||||
- [ ] Task: Write failing test (or link audit) that identifies outdated setup steps or broken links.
|
||||
- [ ] Task: Update `Readme.md` with `uv` setup, current project vision, and feature lists (Conductor, GUI 2.0).
|
||||
- [ ] Task: Perform a project-wide link validation of all Markdown files in `./docs/` and the root.
|
||||
- [ ] Task: Verify setup instructions by performing a manual walkthrough of the Readme steps.
|
||||
- [ ] Task: Conductor - User Manual Verification 'README Refresh and Link Validation' (Protocol in workflow.md)
|
||||
---
|
||||
[checkpoint: (SHA will be recorded here)]
|
||||
38
conductor/tracks/documentation_refresh_20260224/spec.md
Normal file
38
conductor/tracks/documentation_refresh_20260224/spec.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# Specification: Documentation Refresh and Context Cleanup
|
||||
|
||||
## Overview
|
||||
This track aims to modernize the project's documentation suite (Architecture, Tools, README) to reflect recent significant architectural additions, including the Conductor framework, the development of `gui_2.py`, and the API hook verification system. It also includes the decommissioning of `MainContext.md`, which has been identified as redundant in the current project structure.
|
||||
|
||||
## Functional Requirements
|
||||
1. **Architecture Update (`docs/guide_architecture.md`):**
|
||||
- Incorporate descriptions of the Conductor framework and its role in spec-driven development.
|
||||
- Document the dual-GUI structure (`gui.py` and `gui_2.py`) and their respective development stages.
|
||||
- Detail the `EventEmitter` and `ApiHookClient` as core architectural components.
|
||||
2. **Tools Update (`docs/guide_tools.md`):**
|
||||
- Refresh documentation for the current MCP toolset.
|
||||
- Add documentation for the API hook client and automated GUI verification tools.
|
||||
- Update performance monitoring tool descriptions.
|
||||
3. **README Refresh (`Readme.md`):**
|
||||
- Update setup instructions (e.g., `uv`, `credentials.toml`).
|
||||
- Highlight new features: Conductor integration, GUI 2.0, and automated testing capabilities.
|
||||
- Ensure the high-level project vision aligns with the current state.
|
||||
4. **Context Cleanup:**
|
||||
- Permanently remove `MainContext.md` from the project root.
|
||||
- Update any internal references pointing to `MainContext.md`.
|
||||
|
||||
## Non-Functional Requirements
|
||||
- **Link Validation:** All internal documentation links must be verified as valid.
|
||||
- **Code-Doc Alignment:** Architectural descriptions must accurately reflect the current code structure.
|
||||
- **Clarity & Brevity:** Documentation should remain concise and targeted at expert-level developers.
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] `MainContext.md` is deleted from the project.
|
||||
- [ ] `docs/guide_architecture.md` is updated and reviewed for accuracy.
|
||||
- [ ] `docs/guide_tools.md` is updated and reviewed for accuracy.
|
||||
- [ ] `Readme.md` setup and feature sections are current.
|
||||
- [ ] All internal links between `Readme.md` and the `./docs/` folder are functional.
|
||||
|
||||
## Out of Scope
|
||||
- Automated documentation generation (e.g., Sphinx, Doxygen).
|
||||
- In-depth documentation for features still in early prototyping stages.
|
||||
- Creating new video or visual walkthroughs.
|
||||
Reference in New Issue
Block a user