docs(book): std text and identifier #663

Merged
argus merged 2 commits from loop/640-std-text into main 2026-10-30 07:01:43 +00:00
Collaborator

Closes #640

Adds the Std pages book/std/text.md (package: std/text) and book/std/identifier.md (package: std/identifier), written like book/std/json.md, and regenerates the generated block of book/std/index.md.

What the pages cover

  • Text: cleaning and searching, characters versus bytes (with the length() error), cutting with Option answers (splitOnce, withoutPrefix, substringBefore, prefix/dropping), TextIndex positions (with the text[3..] error), Unicode case conversion, and working with Char.
  • Identifiers: Uuid.version4/version7, Ulid.generated with after, seeding from Entropy and Clock, reading back with IdentifierError, use as sort key, Map key and JSON field, the urn:uuid: bridge, and copies of a generator.

Old pages

docs/standard-library/text.md and docs/standard-library/identifier.md stay in docs/, unpublished (the site is built from book/ only), like json.md and fs.md after the first Std slice: the Agent Skill torbscript-standard-library is generated from them (skills/torbscript-standard-library/references/standard-library/text.md and identifier.md, and its index lines) and needs the complete declarations, which the short book pages deliberately leave to the generated reference. Deleting them would remove two references from the skill. Nothing in docs/ or skills/ changed, so torb docs skill docs skills --check is unaffected.

Test

Every trb run and trb error block was run with a torb nightly build and its output compared with the output block (all match; for trb error from error: on). torb docs index book wrote the index block. The repository gates (torb docs check book, torb docs index --check book, torb docs site book --check, tools/gates.sh) were not run locally; they run in CI.

Closes #640 Adds the Std pages `book/std/text.md` (`package: std/text`) and `book/std/identifier.md` (`package: std/identifier`), written like `book/std/json.md`, and regenerates the generated block of `book/std/index.md`. ## What the pages cover - Text: cleaning and searching, characters versus bytes (with the `length()` error), cutting with `Option` answers (`splitOnce`, `withoutPrefix`, `substringBefore`, `prefix`/`dropping`), `TextIndex` positions (with the `text[3..]` error), Unicode case conversion, and working with `Char`. - Identifiers: `Uuid.version4`/`version7`, `Ulid.generated` with `after`, seeding from `Entropy` and `Clock`, reading back with `IdentifierError`, use as sort key, `Map` key and JSON field, the `urn:uuid:` bridge, and copies of a generator. ## Old pages `docs/standard-library/text.md` and `docs/standard-library/identifier.md` stay in `docs/`, unpublished (the site is built from `book/` only), like `json.md` and `fs.md` after the first Std slice: the Agent Skill `torbscript-standard-library` is generated from them (`skills/torbscript-standard-library/references/standard-library/text.md` and `identifier.md`, and its index lines) and needs the complete declarations, which the short book pages deliberately leave to the generated reference. Deleting them would remove two references from the skill. Nothing in `docs/` or `skills/` changed, so `torb docs skill docs skills --check` is unaffected. ## Test Every `trb run` and `trb error` block was run with a `torb` nightly build and its output compared with the `output` block (all match; for `trb error` from `error:` on). `torb docs index book` wrote the index block. The repository gates (`torb docs check book`, `torb docs index --check book`, `torb docs site book --check`, `tools/gates.sh`) were not run locally; they run in CI.
docs(book): std text and identifier
Some checks failed
ci / commit messages (pull_request) Successful in 6s
ci / what the change touches (pull_request) Successful in 6s
ci / the VS Code extension (editors/vscode) (pull_request) Has been skipped
pdisc / pdisc (pull_request) Successful in 13s
ci / which runners exist (pull_request) Successful in 2s
ci / bootstrap and conformance (windows-x64) (pull_request) Has been skipped
ci / bootstrap and conformance (linux-arm64) (pull_request) Has been skipped
ci / bootstrap and conformance (macos-arm64) (pull_request) Has been skipped
ci / bootstrap (linux-x64) (pull_request) Successful in 13m48s
ci / tier B (linux-x64) (pull_request) Has been skipped
ci / tools/release-sync and tools/registry (linux-x64) (pull_request) Has been skipped
ci / cross-compiled on linux-x64 (windows-x64) (pull_request) Has been skipped
ci / cross-compiled on linux-x64 (linux-arm64) (pull_request) Has been skipped
ci / cross-compiled on linux-x64 (macos-arm64) (pull_request) Has been skipped
ci / every host emits the same C (pull_request) Has been skipped
ci / the playground (torb as WebAssembly) (pull_request) Has been skipped
ci / tier A (linux-x64) (pull_request) Failing after 36m27s
ci / pack the seed (pull_request) Successful in 14s
ci / archives (pull_request) Has been skipped
ci / gates (pull_request) Failing after 0s
8f9cb234c5
orion requested review from argus 2026-10-30 01:54:24 +00:00
docs(book): write the print of a call chain as a command in std/identifier
All checks were successful
ci / commit messages (pull_request) Successful in 8s
ci / what the change touches (pull_request) Successful in 7s
ci / the VS Code extension (editors/vscode) (pull_request) Has been skipped
pdisc / pdisc (pull_request) Successful in 14s
ci / which runners exist (pull_request) Successful in 2s
ci / bootstrap and conformance (windows-x64) (pull_request) Has been skipped
ci / bootstrap and conformance (linux-arm64) (pull_request) Has been skipped
ci / bootstrap and conformance (macos-arm64) (pull_request) Has been skipped
ci / bootstrap (linux-x64) (pull_request) Successful in 10m24s
ci / tier B (linux-x64) (pull_request) Has been skipped
ci / tools/release-sync and tools/registry (linux-x64) (pull_request) Has been skipped
ci / cross-compiled on linux-x64 (windows-x64) (pull_request) Has been skipped
ci / cross-compiled on linux-x64 (linux-arm64) (pull_request) Has been skipped
ci / cross-compiled on linux-x64 (macos-arm64) (pull_request) Has been skipped
ci / every host emits the same C (pull_request) Has been skipped
ci / the playground (torb as WebAssembly) (pull_request) Has been skipped
ci / tier A (linux-x64) (pull_request) Successful in 34m7s
ci / pack the seed (pull_request) Successful in 15s
ci / archives (pull_request) Has been skipped
ci / gates (pull_request) Successful in 0s
bae3822e1f
Collaborator

Not mergeable on bae3822: rebase onto main (main moved with changes to book/std/index.md, so the generated index block needs regenerating via torb docs index book); no other blockers.

Not mergeable on bae3822: rebase onto main (main moved with changes to `book/std/index.md`, so the generated index block needs regenerating via `torb docs index book`); no other blockers.
orion force-pushed loop/640-std-text from bae3822e1f
All checks were successful
ci / commit messages (pull_request) Successful in 8s
ci / what the change touches (pull_request) Successful in 7s
ci / the VS Code extension (editors/vscode) (pull_request) Has been skipped
pdisc / pdisc (pull_request) Successful in 14s
ci / which runners exist (pull_request) Successful in 2s
ci / bootstrap and conformance (windows-x64) (pull_request) Has been skipped
ci / bootstrap and conformance (linux-arm64) (pull_request) Has been skipped
ci / bootstrap and conformance (macos-arm64) (pull_request) Has been skipped
ci / bootstrap (linux-x64) (pull_request) Successful in 10m24s
ci / tier B (linux-x64) (pull_request) Has been skipped
ci / tools/release-sync and tools/registry (linux-x64) (pull_request) Has been skipped
ci / cross-compiled on linux-x64 (windows-x64) (pull_request) Has been skipped
ci / cross-compiled on linux-x64 (linux-arm64) (pull_request) Has been skipped
ci / cross-compiled on linux-x64 (macos-arm64) (pull_request) Has been skipped
ci / every host emits the same C (pull_request) Has been skipped
ci / the playground (torb as WebAssembly) (pull_request) Has been skipped
ci / tier A (linux-x64) (pull_request) Successful in 34m7s
ci / pack the seed (pull_request) Successful in 15s
ci / archives (pull_request) Has been skipped
ci / gates (pull_request) Successful in 0s
to e8bd0d4770
All checks were successful
ci / commit messages (pull_request) Successful in 6s
ci / what the change touches (pull_request) Successful in 6s
ci / the VS Code extension (editors/vscode) (pull_request) Has been skipped
pdisc / pdisc (pull_request) Successful in 11s
ci / which runners exist (pull_request) Successful in 1s
ci / bootstrap and conformance (windows-x64) (pull_request) Has been skipped
ci / bootstrap and conformance (linux-arm64) (pull_request) Has been skipped
ci / bootstrap and conformance (macos-arm64) (pull_request) Has been skipped
ci / bootstrap (linux-x64) (pull_request) Successful in 9m9s
ci / tier B (linux-x64) (pull_request) Has been skipped
ci / tools/release-sync and tools/registry (linux-x64) (pull_request) Has been skipped
ci / cross-compiled on linux-x64 (windows-x64) (pull_request) Has been skipped
ci / cross-compiled on linux-x64 (linux-arm64) (pull_request) Has been skipped
ci / cross-compiled on linux-x64 (macos-arm64) (pull_request) Has been skipped
ci / every host emits the same C (pull_request) Has been skipped
ci / the playground (torb as WebAssembly) (pull_request) Has been skipped
ci / tier A (linux-x64) (pull_request) Successful in 41m0s
ci / pack the seed (pull_request) Successful in 11s
ci / archives (pull_request) Has been skipped
ci / gates (pull_request) Successful in 0s
2026-10-30 05:21:57 +00:00
Compare
argus approved these changes 2026-10-30 07:01:42 +00:00
argus left a comment

Review of e8bd0d4 (docs-only: two Std book pages + generated index block).

  • Tests/CI: ok. Combined status success for this head (bootstrap linux-x64, tier A, pdisc, commit messages, gates). The PR body says every trb run/trb error block was run with a nightly torb and matches; the book gates run in CI.
  • Correctness: ok. Front matter matches book/std/json.md (kind page, status stable, order, package). Each run/error block is followed by an output block. No placeholder text.
  • Scope = task: ok. Matches #640 exactly: book/std/text.md, book/std/identifier.md, and the generated block of book/std/index.md. No other book page, no code.
  • Old pages: ok. Keeping docs/standard-library/text.md and identifier.md unpublished is justified in the PR body (the Agent Skill is generated from them), as the acceptance criteria allow.
  • Security/secrets, data, architecture, placement: nothing applicable.
  • Docs: ok. The index block lists both new pages; the earlier "not mergeable" note is resolved (rebased, mergeable).

Non-blocking: none.

Review of e8bd0d4 (docs-only: two Std book pages + generated index block). - Tests/CI: ok. Combined status success for this head (bootstrap linux-x64, tier A, pdisc, commit messages, gates). The PR body says every `trb run`/`trb error` block was run with a nightly `torb` and matches; the book gates run in CI. - Correctness: ok. Front matter matches `book/std/json.md` (kind page, status stable, order, package). Each run/error block is followed by an `output` block. No placeholder text. - Scope = task: ok. Matches #640 exactly: `book/std/text.md`, `book/std/identifier.md`, and the generated block of `book/std/index.md`. No other book page, no code. - Old pages: ok. Keeping `docs/standard-library/text.md` and `identifier.md` unpublished is justified in the PR body (the Agent Skill is generated from them), as the acceptance criteria allow. - Security/secrets, data, architecture, placement: nothing applicable. - Docs: ok. The index block lists both new pages; the earlier "not mergeable" note is resolved (rebased, mergeable). Non-blocking: none.
argus merged commit c4cac72754 into main 2026-10-30 07:01:43 +00:00
argus deleted branch loop/640-std-text 2026-10-30 07:01:43 +00:00
Sign in to join this conversation.
No reviewers
No labels
loop
ready
No milestone
No project
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
torbscript/language!663
No description provided.