Repository navigation
docs(studio): write down what Studio does not tell you about itself - #3165
Merged
Merged
Conversation
Working in packages/studio for the first time costs a day rediscovering things the source does not show: that the chrome is a measurement drawn in Studio's document over an iframe, that some gestures cannot be synthesised at all so a driver needs window.__studioTest, that the diagnostic channels exist and are off by default, that bare `bun test` reports failures that are not real, and which gates reject a PR. Scoped to the package, following docs/AGENTS.md, and pointed at from the project-structure list in both root files so it is found before the first edit rather than after.
miguel-heygen
added a commit
that referenced
this pull request
Aug 10, 2026
oxfmt formats markdown, and the file added in #3165 was not run through it. main's Format check has been failing since that merge, which also fails every open PR, since CI checks the merge with main.
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.
What
packages/studio/AGENTS.md— a short guide for an agent or a person making their first change in Studio. Pointed at from the project-structure list in the rootCLAUDE.mdandAGENTS.md.Why
Everything in it cost real time to rediscover, and none of it is visible from the source:
page.mouseclick pairs never open a text edit.window.__studioTest.selectByDomId(id)exists for exactly this and is easy to miss.bun testin this package reports failures that are not real.How
Scoped to the package, following the existing
docs/AGENTS.mdprecedent rather than growing the root files.Every claim was verified against the source on main: the channel names against
makeStudioDebugLoggercall sites, the test-hook gate againstSTUDIO_TEST_HOOKS_ENABLED, and the file-size rule against the CI workflow. Nothing about the in-flight rich-text editor is described here, since it is not on main yet.Test plan
__studioTest.selectByDomIdwas used to drive a real verification this week, which is what prompted writing it down