Skip to content

Commit e556d98

Browse files
committed
docs: clarify internal engineering guidance
1 parent 7008890 commit e556d98

4 files changed

Lines changed: 134 additions & 150 deletions

File tree

DEVELOPMENT.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@ bun install
1313
- `bun run check` — typecheck, lint, and dead-code scan (`knip`)
1414
- `bun test` — small durable invariant suite
1515

16-
### Packaging And Release Confidence
16+
### Packaging And Release
1717

1818
- `bun run build:package` — emit `dist/` for the published ESM package
1919
- `bun run package-smoke-test` — pack the tarball and verify temporary JS + TS consumers
2020
- `bun run site:build` — build the static demo site into `site/`
2121
- `bun run generate:bidi-data` — refresh the checked-in simplified Unicode bidi ranges
2222

23-
`prepack` also rebuilds `dist/` through plain `tsc`, so keep runtime `.js` specifiers honest in source imports.
23+
`prepack` also rebuilds `dist/` through plain `tsc`, so source imports need `.js` specifiers that remain valid in the emitted files.
2424

2525
### Browser Accuracy And Benchmarking
2626

@@ -32,15 +32,15 @@ bun install
3232
- `bun run accuracy-snapshot:firefox`
3333
- `bun run benchmark-check` — Chrome benchmark snapshot; default is the median of 3 full page runs, use `--runs=1` for a quick local check
3434
- `bun run benchmark-check:safari`
35-
- `bun run pre-wrap-check`compact batched browser oracle for `{ whiteSpace: 'pre-wrap' }`
36-
- `bun run keep-all-check`compact batched browser oracle for `{ wordBreak: 'keep-all' }`, including mixed-script no-space canaries
37-
- `bun run symbol-check`compact batched Chrome + Safari oracle for no-space symbol runs inside long words
38-
- `bun run letter-spacing-check`compact batched Chrome + Safari oracle for `{ letterSpacing }`
39-
- `bun run letter-spacing-snapshot` — refresh `accuracy/letter-spacing.json` from the Chrome + Safari compact `{ letterSpacing }` oracle
40-
- `bun run probe-check` — smaller browser probe/diagnostic entrypoint
35+
- `bun run pre-wrap-check`small batched browser check for `{ whiteSpace: 'pre-wrap' }`
36+
- `bun run keep-all-check`small batched browser check for `{ wordBreak: 'keep-all' }`, including mixed-script text without spaces
37+
- `bun run symbol-check`small batched Chrome + Safari check for symbol runs inside long words
38+
- `bun run letter-spacing-check`small batched Chrome + Safari check for `{ letterSpacing }`
39+
- `bun run letter-spacing-snapshot` — refresh `accuracy/letter-spacing.json` from the Chrome + Safari `{ letterSpacing }` check
40+
- `bun run probe-check` — smaller browser diagnostic
4141
- `bun run probe-check:safari`
4242

43-
Probe output includes a break trace on first-break mismatches. `sN:gM` is a segment/grapheme position; `[ours]` and `[browser]` mark the competing boundaries. For extractor-sensitive Safari cases, cross-check `--method=span` before changing the engine.
43+
When a probe finds a first-break mismatch, the report includes a short trace. `sN:gM` identifies a segment and grapheme; `[ours]` and `[browser]` identify the competing break positions. Safari `Range` extraction can be wrong around preserved whitespace and URL queries even when the rendered height is correct, so compare `--method=span` before changing the engine.
4444

4545
### Corpus Tooling
4646

@@ -50,7 +50,7 @@ Probe output includes a break trace on first-break mismatches. `sN:gM` is a segm
5050
- `bun run corpus-sweep:safari` — maintained Safari `step=10` corpus width sweep
5151
- `bun run corpus-font-matrix` — same corpus under alternate fonts
5252
- `bun run corpus-font-matrix:safari`
53-
- `bun run corpus-taxonomy`classify a mismatch field into steering buckets
53+
- `bun run corpus-taxonomy`group corpus mismatches by likely cause
5454
- `bun run corpus-status` — rebuild `corpora/dashboard.json`
5555
- `bun run corpus-status:refresh` — refresh Chrome and Safari `step=10` sweeps, then the corpus dashboard
5656

@@ -67,16 +67,16 @@ Probe output includes a break trace on first-break mismatches. `sN:gM` is a segm
6767

6868
## Current Dashboards And Snapshots
6969

70-
Use these for the current checked-in picture:
70+
Use these for the current checked-in results:
7171

7272
- [status/dashboard.json](status/dashboard.json) — machine-readable main dashboard
7373
- [accuracy/chrome.json](accuracy/chrome.json), [accuracy/safari.json](accuracy/safari.json), [accuracy/firefox.json](accuracy/firefox.json) — raw browser accuracy rows
74-
- [accuracy/letter-spacing.json](accuracy/letter-spacing.json)compact Chrome + Safari `{ letterSpacing }` oracle snapshot
74+
- [accuracy/letter-spacing.json](accuracy/letter-spacing.json)results from the small Chrome + Safari `{ letterSpacing }` check
7575
- [benchmarks/chrome.json](benchmarks/chrome.json), [benchmarks/safari.json](benchmarks/safari.json) — raw benchmark snapshots
7676
- [corpora/dashboard.json](corpora/dashboard.json) — machine-readable corpus dashboard
7777
- [corpora/chrome-step10.json](corpora/chrome-step10.json), [corpora/safari-step10.json](corpora/safari-step10.json) — checked-in browser `step=10` corpus sweep snapshots
7878

79-
[PLATFORM_BUGS.md](PLATFORM_BUGS.md) is the current browser/OS issue and workaround ledger. [RESEARCH.md](RESEARCH.md) keeps durable findings and rejected approaches; it is not a source for current counts or tracker status.
79+
[PLATFORM_BUGS.md](PLATFORM_BUGS.md) lists current browser and OS issues and their workarounds. [RESEARCH.md](RESEARCH.md) keeps durable findings and rejected approaches; it is not a source for current counts or issue status.
8080

8181
## Deep Profiling
8282

@@ -87,4 +87,4 @@ For one-off performance and memory work, start with `bun start` and an isolated,
8787
- Use heap sampling for allocation churn.
8888
- Diff forced-GC heap snapshots for retained memory.
8989

90-
Bun/Node microbenchmarks are useful for cheap hypotheses, but browser behavior needs browser evidence.
90+
Bun/Node microbenchmarks are useful for quick experiments, but browser behavior needs browser measurements.

0 commit comments

Comments
 (0)