Skip to content

docs: research/ layout convention (experiment journals)#426

Draft
obj-p wants to merge 2 commits into
mainfrom
research-layout-convention
Draft

docs: research/ layout convention (experiment journals)#426
obj-p wants to merge 2 commits into
mainfrom
research-layout-convention

Conversation

@obj-p

@obj-p obj-p commented Jul 16, 2026

Copy link
Copy Markdown
Owner

Standardizes the research/ layout so every experiment reads as a journal: what it asks, how to run it, what it found, and whether the claim still holds on the current toolchain.

What this adds

research/README.md defining:

  • One experiment = one directory = one claim, with a journal template (Question / Environment / Run / Result / Conclusion / Status).
  • Two tiers: reproduction (a reproduce.sh re-runs the experiment and asserts against a committed expectation; red = toolchain drift) and capture (frozen one-off data marked with the environment it was taken in).
  • Migration policy for the research branches (previews-research, previews-research-3201, archive/*): no bulk copy — redo high-leverage findings against the current toolchain, restart from the committed jit-poc/ and previews-re/, select by leverage.
  • Re-experiment cadence: re-run every reproduction on each Xcode/macOS major (Xcode 27 and beyond); red is the finding.

Out of scope (follow-ups)

  • Conforming jit-poc/README.md and previews-re/README.md to the template headings — reevaluated after the template settles.
  • The actual branch migration.

Draft to iterate on the template wording. No gates run yet.

🤖 Generated with Claude Code

https://claude.ai/code/session_01Bi4bG4Dtkc5GTYqkoUkGdB

obj-p and others added 2 commits July 15, 2026 20:52
Comment thread research/README.md
**Question.** The single hypothesis this experiment tests.

**Environment.** What it needs: host tier (VM-free) or vzy snapshot
(`post-xcode`, `post-xcode-sip-amfi`, …); toolchain requirements; the

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove this parenthesis. Those details grow stale (e.g. post-xcode). The vzy script should be self documentating.

Comment thread research/README.md
Experiments that guide the architecture of PreviewsMCP. Each experiment
validates a claim about Xcode, swiftc, LLVM, or macOS that an architectural
decision rests on, and stays re-runnable so the claim can be re-checked when
the toolchain moves (a new Xcode or macOS major). Non-shipping: nothing here

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we even need the Non-shipping line?

Comment thread research/README.md
claim still holds on the current toolchain; red means drift. VM-dependent
reproductions boot the snapshot they need via
[vzy](https://github.com/obj-p/vzy).
- **Capture** — the exception, for one-off empirical data that is too costly

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's okay to commit abbreviated captures as long as it's a scripted result and reproducible. It's nice to have the output immediately for context.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant