Repository navigation
docs(playground): Add JSDoc for React state and editor contracts [skip chg] - #12234
Closed
Timothee Guerin (timotheeguerin) wants to merge 2 commits into
Closed
Timothee Guerin (timotheeguerin) wants to merge 2 commits into
Timothee Guerin (timotheeguerin) wants to merge 2 commits into
Conversation
commit: |
29 of 30 tasks
|
You can try these changes here
|
Timothee Guerin (timotheeguerin)
marked this pull request as ready for review
October 16, 2026 13:44
Timothee Guerin (timotheeguerin)
requested review from
catalinaperalta,
iscai-msft,
Laurent Mazuel (lmazuel) and
Mark Cowlishaw (markcowl)
as code owners
October 16, 2026 13:44
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The documentation-only changes have no unresolved findings and preserve existing APIs and runtime behavior.
0 open findings
What changed in this PR
Documents the playground’s React integration contracts as part of #12228, without changing public signatures or runtime behavior.
Changes:
- Clarifies state ownership, YAML precedence, snapshot replacement, and save payloads.
- Documents Monaco resource lifetime, compilation results, and context access.
| File | Description |
|---|---|
packages/playground/src/react/use-playground-state.ts |
Documents state modes, derived values, and update callbacks. |
packages/playground/src/react/types.ts |
Clarifies compilation results and output identifiers. |
packages/playground/src/react/hooks/use-editor-actions.ts |
Documents save payload contents. |
packages/playground/src/react/editor.tsx |
Explains editor props and model ownership. |
packages/playground/src/react/editor-panel/tspconfig-utils.ts |
Clarifies YAML preservation and fallback behavior. |
packages/playground/src/react/context/playground-context.tsx |
Documents context services and provider requirements. |
🧠 Review effort: Balanced
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Member
Author
Timothee Guerin (timotheeguerin)
added a commit
that referenced
this pull request
Oct 16, 2026
Embedding the playground requires contracts for hosts, storage, build integration, editor state, and output viewers that are currently scattered or missing. Document the public playground APIs together, including defaults, state transitions, output identifiers, and YAML-preservation limitations. Existing editor and viewer behavior is unchanged. Consolidates [12234](#12234), [12238](#12238). Tracked in #12228.
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.
Embedding the playground requires knowing which state is authoritative and who owns editor resources. Document controlled versus uncontrolled state, YAML-derived values, snapshot replacement, save payloads, Monaco model lifetime, and context access so integrations do not depend on reading private hooks.
Public signatures, rendering, and runtime behavior are unchanged.
Tracked in #12228.