docs: route readers to the current engine contract - #85
Merged
thejustinwalsh merged 1 commit intoAug 20, 2026
Conversation
Both indexes presented `engine-integration-contract.md` and `raster-technique-api.md` as authoritative while each document self-marks `status: deprecated` and opens with "Historical design record". Someone building a custom renderer from the index would implement a superseded TypeScript storage and packing contract. The two documents were not the problem: each already routes readers on to `packages/glyph.md` and `rust-layout-engine.md`. Only the indexes misrouted, and they did so because the actual authority was missing from them -- `rust-layout-engine.md` is what `README.md:315` sends custom-renderer integrators to, and it appeared in neither `docs/index.md` nor `docs/planning/index.md`. Both now list it first among the engine entries, so the working path is reachable from the index rather than only from the README. `api-shapes.md` claimed "merged v0 surfaces are implemented but unreleased" across 1,277 lines describing a surface `roadmap.md:827` records as deleted, and its own note pointed at the deprecated engine-integration contract. The status now says superseded and the note points at the current reference. Superseded entries follow the wording already used for `text-effect-composition.md`: name what replaced them rather than removing the link, so the retired design stays discoverable.
size-limit report 📦
|
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
1 participant
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.
Both indexes presented
engine-integration-contract.mdandraster-technique-api.mdas authoritative while each document self-marksstatus: deprecatedand opens with "Historical design record". Someonebuilding a custom renderer from the index would implement a superseded
TypeScript storage and packing contract.
The two documents were not the problem: each already routes readers on to
packages/glyph.mdandrust-layout-engine.md. Only the indexesmisrouted, and they did so because the actual authority was missing from
them --
rust-layout-engine.mdis whatREADME.md:315sends custom-rendererintegrators to, and it appeared in neither
docs/index.mdnordocs/planning/index.md. Both now list it first among the engine entries,so the working path is reachable from the index rather than only from the
README.
api-shapes.mdclaimed "merged v0 surfaces are implemented but unreleased"across 1,277 lines describing a surface
roadmap.md:827records as deleted,and its own note pointed at the deprecated engine-integration contract. The
status now says superseded and the note points at the current reference.
Superseded entries follow the wording already used for
text-effect-composition.md: name what replaced them rather than removingthe link, so the retired design stays discoverable.
Stack created with GitHub Stacks CLI • Give Feedback 💬