docs: one md per corelib module (docs/corelib/*.md), indexed from LANGUAGE.md - #155
Merged
Conversation
Move the per-module stdlib API reference (core.io, core.test, core.cli, core.time) out of docs/LANGUAGE.md into one focused file per module under docs/corelib/, indexed from a new "Standard library" section in LANGUAGE.md. LANGUAGE.md keeps the language reference (syntax, types, semantics incl. the concurrency/deferred-values model, feature matrix). Docs-only; faithful move. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
- ROADMAP.md: concurrency link used `-planned`; the heading anchor is `-in-progress`. - corelib io.md/test.md: the render-operator heading ends in `(`)`, so its GitHub anchor carries a trailing hyphen; the links were missing it (a latent bug pre-dating the corelib split, carried over in the faithful move). Verified with github-slugger: all 14 LANGUAGE.md#anchor links across docs/ resolve. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
assapir
force-pushed
the
docs-corelib-split
branch
from
August 21, 2026 12:25
94be66d to
de21b84
Compare
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.
Split the stdlib/library API reference out of
docs/LANGUAGE.mdinto one markdown file per corelib module, indexed from LANGUAGE.md. Docs-only, faithful move — no behavior change.What moved out of LANGUAGE.md
The per-module library API reference sections, relocated verbatim (lightly reformatted per file):
docs/corelib/io.md—core.io:print/eprint/write,stdout/stderr,@readStdin(was "## I/O —<< core.io").docs/corelib/test.md—core.test:assert/AssertOpts/assertEq/assertNotEq/assertOk/assertNotOk(was "## Assertions —<< core.test").docs/corelib/cli.md—core.cli:getEnv/hasFlag/getOpt(was "## CLI helpers —<< core.cli").docs/corelib/time.md—core.time:@sleep/now(its API reference; the source was the "runnable today" paragraph woven into the concurrency section).What stayed in LANGUAGE.md
The language reference: syntax, types, semantics, the concurrency / colorless-implicit-futures model (language semantics — the
@sleep/@readStdinnarrative that illustrates the model stays), the entry point, and the feature matrix. LANGUAGE.md gains a concise "Standard library" index section with a one-line description + link to eachdocs/corelib/*.md, and the Modules bullet now points at that index.Links
Every
docs/corelib/*.mdlink from LANGUAGE.md resolves; corelib files link back with../LANGUAGE.md#anchor(all anchors verified against real headings); no dangling references left behind (README / other docs unaffected).PARKED — do not merge without explicit approval.
🤖 Generated with Claude Code