Skip to content

P2-D: Sync documentation with current implementation and planned features #94

@devlux76

Description

@devlux76

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, and README.md accordingly.
  • 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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    P2: mediumMedium priority — targets v1.0layer: documentationAPI docs, developer guide, architecture diagrams

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions