Skip to content

docs: document native plan mode - #90

Closed
jefft72 wants to merge 2 commits into
plan/11-lifecycle-testsfrom
plan/12-docs
Closed

jefft72 wants to merge 2 commits into
plan/11-lifecycle-testsfrom
plan/12-docs

Conversation

@jefft72

@jefft72 jefft72 commented Aug 16, 2026

Copy link
Copy Markdown
Contributor

Summary

Documents native plan mode across the README, usage guide, SDK reference, session format, JSON and TUI docs, and the plan mode extension example.

Replaces #76.

Reasoning

Plan mode shipped with no reference material, so neither users nor SDK consumers had a description of the tool policy, the persistence model, or the continuation contract.
The continuation semantics in particular need documenting, because the token is single-use and the retry behaviour after a failed preflight is not obvious from the API shape.

Task profile routing prose is left to the integration stack, so these docs describe only behaviour that exists on main.

Changes

  • Documents plan mode in the README and usage guide, including --plan and /plan
  • Documents the plan tool policy, artifact, resolution, and continuation contract in the SDK reference
  • Documents plan session entries in the session format reference
  • Updates the JSON, TUI, and extensions docs, and the plan mode example README

Testing

  • tsgo --noEmit reports zero errors
  • biome check . clean
  • Verified no em dashes were introduced in Markdown

Document plan-mode commands, SDK controls, structured output, session records, task profiles, extension behavior, and usage examples.
- Plan mode shipped without any reference material, so users and SDK consumers had no description of the tool policy, persistence, or continuation contract
- Task profile routing prose is left to the integration stack so these docs describe only behaviour that exists on main
@Pepps233
Pepps233 self-requested a review August 16, 2026 18:50
@Pepps233 Pepps233 added documentation Improvements or additions to documentation coding-agent labels Aug 16, 2026
@Pepps233
Pepps233 requested a review from Issacboy123 August 16, 2026 18:51

@Issacboy123 Issacboy123 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The SDK documentation usefully presents plan state, lifecycle methods, events, persistence, and tool policy as one public contract. Its export inventory is part of that contract, but it lists three profile-routing helpers that are neither implemented nor exported. Keep the inventory synchronized with the package index. This issue persists through the stack.

getReadmePath
getDocsPath
getExamplesPath
buildAcceptedPlanProfileRouterPrompt

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These three accepted-plan profile-routing names do not exist in the source tree and are not exported from the package index. Please remove the stale entries or add the intended implementations and public exports.

@Pepps233 Pepps233 closed this Sep 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

coding-agent documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants