Repository navigation
docs: split the README into topic pages under docs/ - #845
Merged
Merged
Conversation
The README was 1005 lines. It now holds a quick start, the memory-model table and a table linking each topic page; the sections moved unchanged to docs/running.md, android.md, wasm.md, tsbindgen.md, performance.md, building.md and whats-new.md. docs/wasm.md leads with the host.mjs runner and keeps the old run.html loader as the older recipe. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
The README was 1005 lines (45 KB). It is now 126: pitch and badges, a quick start, the memory-model table, a documentation table linking every topic page, the native_ts_graphics showcase, community and licence.
The sections moved unchanged (copied by line range) to:
docs/whats-new.mddocs/running.mddocs/android.mddocs/wasm.md(leads with thetslang/test/wasmhost.mjs runner; the oldrun.htmlloader kept as the older recipe)docs/tsbindgen.mddocs/performance.mddocs/building.md-mm=ownsectiondocs/own-memory-model.mdhas the same examplesdocs/own-memory-model.mdlinked toREADME.md#performance; it now links toperformance.md. Every code block of the old README is in the new pages (the two-mm=ownones in the own guide), and every relative link and anchor resolves.Possibly stale, moved as is: the fully checked Roadmap, the "Migrated to LLVM 19.1.3" entry, the "Migrared" typo, and the old
run.htmlwasm loader.🤖 Generated with Claude Code