docs: make tutorials self-contained and document the current core API - #37
Merged
Merged
Conversation
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.
Core tutorials previously linked runnable files without showing their implementation, and the API reference omitted the current Session/composition surface. Developers can now build the synthetic notes Agent using complete files on each EN/zh page, follow its lifecycle and extension lessons, and navigate to source-checked API signatures.
Validation: 787 passed / 1 Docker opt-in skip across the targeted suites; separate Docker-page/golden-path/scaffold/smoke qualification 17 passed. 166 MDX pages compile, and 46 changed routes rendered successfully at desktop and mobile widths. Clipboard and symbol-anchor navigation passed. Runtime, package metadata and quality allowances are unchanged.
Known boundary: concurrent same-Session handoff destination restore and source completion callbacks can conflict on owner CAS at the frozen runtime. The runnable example explicitly serializes transfer acknowledgement, source cleanup and destination execution, verifies actual destination execution, and records the unsupported concurrent case without changing the kernel.
Runtime identity: 60809b3. Historical G5 qualification remains bound to 717b4cf. See docs/internal/plans/docs_self_contained_qualification.md for source-bound local evidence. Live Mintlify publication is verified separately after merge.