Repository navigation
Conversation
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
self-requested a review
August 16, 2026 18:50
Issacboy123
requested changes
Aug 17, 2026
Issacboy123
left a comment
Contributor
There was a problem hiding this comment.
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 |
Contributor
There was a problem hiding this comment.
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
--planand/planTesting
tsgo --noEmitreports zero errorsbiome check .clean