-
Notifications
You must be signed in to change notification settings - Fork 0
Closed
Labels
P2: mediumMedium priority — targets v1.0Medium priority — targets v1.0layer: documentationAPI docs, developer guide, architecture diagramsAPI docs, developer guide, architecture diagrams
Milestone
Description
Parent issue: Part of #89
Problem
Several parts of the docs (wiki and DESIGN.md) describe functionality that does not currently exist or has diverged from the implementation (e.g., dialectical retrieval, hierarchy building, sharing guardrails). Without alignment, contributors and reviewers may assume behavior that is not implemented.
Goal
Audit all documentation artifacts and update them to accurately reflect current behavior, or update the implementation to match the documented design where appropriate.
Acceptance Criteria
- Identify and list doc sections that are inaccurate or outdated.
- Update doc content in the wiki,
DESIGN.md, andREADME.mdaccordingly. - If a doc claim is a desired feature that is actively being implemented, mark it clearly (e.g., "planned" or link to the relevant issue).
- Ensure docs contain no “future” language for features that already exist (and vice versa).
Notes
This task is about alignments; it does not require implementing missing features, but it should drive the creation of implementation tasks when appropriate.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
P2: mediumMedium priority — targets v1.0Medium priority — targets v1.0layer: documentationAPI docs, developer guide, architecture diagramsAPI docs, developer guide, architecture diagrams