Skip to content

docs: split the README into topic pages under docs/ - #845

Merged
ASDAlexander77 merged 1 commit into
mainfrom
readme-reorganise
Nov 13, 2026
Merged

ASDAlexander77 merged 1 commit into
mainfrom
readme-reorganise

Conversation

@ASDAlexander77

Copy link
Copy Markdown
Owner

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:

Old section New page
What's new, Roadmap docs/whats-new.md
Example, JIT, JIT cache, GDB, compile as executable docs/running.md
Compile for Android, Build for Android docs/android.md
Compiling as WASM docs/wasm.md (leads with the tslang/test/wasm host.mjs runner; the old run.html loader kept as the older recipe)
tsbindgen docs/tsbindgen.md
Performance docs/performance.md
Build from source docs/building.md
-mm=own section dropped: docs/own-memory-model.md has the same examples

docs/own-memory-model.md linked to README.md#performance; it now links to performance.md. Every code block of the old README is in the new pages (the two -mm=own ones 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.html wasm loader.

🤖 Generated with Claude Code

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>
@ASDAlexander77
ASDAlexander77 merged commit 3392fef into main Nov 13, 2026
8 checks passed
@ASDAlexander77
ASDAlexander77 deleted the readme-reorganise branch November 13, 2026 21:33
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