docs: link the mobile-ink engineering write-up - #41
Merged
Conversation
Adds a link to the published engineering post from the three surfaces that get crawled: the README intro (mirrored onto the npm package page), the README documentation index, and the continuous-canvas section of the architecture doc. The architecture note also states inline why native canvases are pooled rather than virtualized, so the reasoning stands on its own without following the link.
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.
Links the published engineering post from the surfaces that actually get crawled and cited, so the repo and the article reference each other instead of the article being an orphan.
Changes
README.md(Why This Exists) — one-line intro to the post. This section is mirrored onto the npm package page, so it lands on two indexed surfaces.README.md(Documentation) — entry in the docs index alongside Architecture, API Reference, and Changelog.docs/architecture.md(Continuous Canvas Model) — states inline why native canvases are pooled rather than virtualized, then links to the post for the approaches that failed first and the settle-handoff behavior.The architecture paragraph is written to stand on its own. A reader who never opens the link still learns why the pool exists, which was missing from that section.
Verification
npm run typecheck— cleannpm test— 57 passed, 10 suitesnpm run build— bob build succeeded (commonjs, module, typescript)npm run pack:dry-run— 362 files, 1.6 MBnpm audit --omit=dev— 0 vulnerabilities in production deps/simplify— one finding applied (tightened a 300-char run-on that duplicated the docs-index description)/security— no secrets, all links HTTPS, no code surface changedDocs-only change; no UI, so no browser verification applies.
Note
npm auditreports 5 findings (1 critical, 3 high, 1 low) in dev dependencies —shell-quote,@babel/core,brace-expansion,js-yaml,ws. All pre-existing onmain, none ship in the package. Worth a separatenpm audit fixPR.