Files
manual_slop/conductor/tracks/documentation_refresh_20260224/plan.md

2.1 KiB

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)

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)]