Skip to content

D-30: Dialogue — documentation update (CLAUDE.md, READMEs, release notes) #280

@kirich1409

Description

@kirich1409

Description

Final documentation pass — update all project docs to reflect Dialogue feature. Ensure every doc surface references the authoritative spec.

Spec: Epic #250 §13 + CLAUDE.md Documentation Maintenance policy.

Scope

CLAUDE.md (root)

  • Architecture section — add AgentChat, AgentChatUI to Swift package list.
  • Add Dialogue summary paragraph with reference to docs/architecture/dialogue.md.
  • Key Patterns — add "SessionSurface routing", "AgentChatSession protocol + Claude JSONL adapter", "Presentation enum with ifCaseLet".
  • Build & Run — any new Claude CLI flags (for local smoke tests).

docs/architecture/dialogue.md (committed in D-4)

  • Final review pass — ensure reflects MVP as shipped, not original plan.
  • Any post-research changes documented inline with "Updated 2026-MM-DD" note.

AgentChat / AgentChatUI READMEs

  • Public API entry points.
  • Owner (for agent-chat-api PR label analogous to ds-api).
  • Change policy.

runner/README.md

  • No changes expected (runner unaffected).
  • If minor — document that stream-json is purely client-side parsed.

Release notes

  • Draft user-facing release notes for the version introducing Dialogue:
    • What's new: Dialogue view for Claude Code sessions.
    • How to enable: Settings → Agents → Enable experimental Dialogue UI.
    • Limitations: see Out-of-MVP list.
    • Keyboard shortcuts: ⌘⇧N, ⌘⇧D, ⌘⇧T, ⌘⌥R.

Acceptance Criteria

  • CLAUDE.md updated with Dialogue architecture summary + package list.
  • docs/architecture/dialogue.md reviewed and dated.
  • AgentChat/README.md + AgentChatUI/README.md exist with required sections.
  • Release notes drafted (commit to docs/releases/ or similar location per project convention).
  • No stale references to old internal names (e.g., chat-mode → all renamed to Dialogue).

Relationships

Metadata

Metadata

Assignees

No one assigned

    Labels

    complexity:SdialogueDialogue feature — structured chat UI for agent sessionsdocumentationImprovements or additions to documentationfrontendwave-5

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions