Repository navigation
docs(playground): Add JSDoc for public APIs [skip chg] - #12231
Merged
Timothee Guerin (timotheeguerin) merged 6 commits intoOct 16, 2026
Merged
Timothee Guerin (timotheeguerin) merged 6 commits into
Timothee Guerin (timotheeguerin) merged 6 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:45
Timothee Guerin (timotheeguerin)
requested review from
catalinaperalta,
iscai-msft,
Laurent Mazuel (lmazuel) and
Mark Cowlishaw (markcowl)
as code owners
October 16, 2026 13:45
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The documentation matches the reviewed implementations, with no runtime changes or unresolved findings.
0 open findings
What changed in this PR
Documents playground integration APIs as part of #12228, without changing public signatures or runtime behavior.
Changes:
- Clarifies browser-host loading, deferred libraries, and Monaco setup.
- Documents URL persistence and falsy-value handling.
- Explains sample loading, Vite configuration, and manifest substitution.
| File | Description |
|---|---|
| packages/playground/src/vite/types.ts | Documents build-time and runtime configuration. |
| packages/playground/src/vite/index.ts | Explains generated Vite configuration. |
| packages/playground/src/types.ts | Documents samples, library metadata, and browser hosts. |
| packages/playground/src/tooling/types.ts | Clarifies sample metadata inputs. |
| packages/playground/src/tooling/index.ts | Documents sample generation and asynchronous failures. |
| packages/playground/src/state-storage.ts | Explains URL serialization and persistence behavior. |
| packages/playground/src/services.ts | Documents Monaco registration lifecycle. |
| packages/playground/src/monaco-worker.ts | Explains worker selection and global setup. |
| packages/playground/src/manifest.ts | Clarifies manifest replacement and fallback behavior. |
| packages/playground/src/browser-host.ts | Documents library loading and import failures. |
🧠 Review effort: Balanced
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Timothee Guerin (timotheeguerin)
changed the title
This was referenced Oct 16, 2026
Timothee Guerin (timotheeguerin)
merged commit Oct 16, 2026
4802e7c
into
microsoft:main
31 of 33 checks passed
Timothee Guerin (timotheeguerin)
deleted the
docs/jsdoc-playground-host
branch
October 16, 2026 16:13
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 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, 12238.
Tracked in #12228.