book: Std pages, data formats #592

Open
opened 2026-10-29 14:25:45 +00:00 by orion · 5 comments
Collaborator

Slice of the epic #582. Starts after #585 (the concept, the vertical slice and the book gates) is merged.

Scope

Write one hand-written page in book/std/ per module: encoding, json-schema, toml, yaml, xml, html, markdown, binary, archive, compression, uri. Each replaces docs/standard-library/<module>.md.

Acceptance criteria

  • Every page has the kind page and is written as book/CONCEPT.md, "How a page is written", says: the first paragraph says what the page covers, headings name ideas, prose first, no history, no internal references, no Related/Next sections
  • Every trb run and trb error block has its output block with the real output; torb docs check book, torb docs index --check book and torb docs site book --check pass in CI
  • The signature features of book/CONCEPT.md that the area touches are shown, not just named
  • The old pages of docs/ this slice replaces are deleted in the same PR, unless a skill is still built from them (then they stay, unpublished, and the PR says which)
  • Each page opens with what the module is for and an example of the most common task, then covers the handful of tasks people use it for, each with an example and its output; it does not list every declaration
  • Each page names its module in the front matter (package: std/<module>), so the site links the generated API reference of torb doc std

Pages

Filed as child issues, each its own PR, all carrying loop; none is ready yet, they are made ready one after the other. The pages are independent (links only to pages already on main), so the order is a suggestion. std/xml.md (#649) waits for the PR of #605, which edits docs/standard-library/xml.md.

  • std/encoding.md - #646 (PR #670 in review)
  • std/json-schema.md - #647
  • std/toml.md, std/yaml.md - #648
  • std/xml.md - #649
  • std/html.md - #650
  • std/markdown.md, std/compression.md - #651
  • std/binary.md, std/archive.md - #652
  • std/uri.md - #653

The old material of the eleven modules is about 143 KB, too much for one PR, so each child is one page or a small group of 2 pages. No other Std slice (#591, #593 to #595) claims these modules.

Slice of the epic #582. Starts after #585 (the concept, the vertical slice and the book gates) is merged. ## Scope Write one hand-written page in `book/std/` per module: `encoding`, `json-schema`, `toml`, `yaml`, `xml`, `html`, `markdown`, `binary`, `archive`, `compression`, `uri`. Each replaces `docs/standard-library/<module>.md`. ## Acceptance criteria - [ ] Every page has the kind `page` and is written as `book/CONCEPT.md`, "How a page is written", says: the first paragraph says what the page covers, headings name ideas, prose first, no history, no internal references, no Related/Next sections - [ ] Every `trb run` and `trb error` block has its `output` block with the real output; `torb docs check book`, `torb docs index --check book` and `torb docs site book --check` pass in CI - [ ] The signature features of `book/CONCEPT.md` that the area touches are shown, not just named - [ ] The old pages of `docs/` this slice replaces are deleted in the same PR, unless a skill is still built from them (then they stay, unpublished, and the PR says which) - [ ] Each page opens with what the module is for and an example of the most common task, then covers the handful of tasks people use it for, each with an example and its output; it does not list every declaration - [ ] Each page names its module in the front matter (`package: std/<module>`), so the site links the generated API reference of `torb doc std` ## Pages Filed as child issues, each its own PR, all carrying `loop`; none is `ready` yet, they are made ready one after the other. The pages are independent (links only to pages already on main), so the order is a suggestion. `std/xml.md` (#649) waits for the PR of #605, which edits `docs/standard-library/xml.md`. - [ ] `std/encoding.md` - #646 (PR #670 in review) - [ ] `std/json-schema.md` - #647 - [ ] `std/toml.md`, `std/yaml.md` - #648 - [ ] `std/xml.md` - #649 - [ ] `std/html.md` - #650 - [ ] `std/markdown.md`, `std/compression.md` - #651 - [ ] `std/binary.md`, `std/archive.md` - #652 - [ ] `std/uri.md` - #653 The old material of the eleven modules is about 143 KB, too much for one PR, so each child is one page or a small group of 2 pages. No other Std slice (#591, #593 to #595) claims these modules.
Author
Collaborator

[loop:torbscript] intake: in scope (book std pages, slice of epic #582; dependency #585 is merged), no duplicate, no design-record collision, no seed impact. Next: refine (size check: 11 module pages in one PR is too large, split into one-page or small-group children).

[loop:torbscript] intake: in scope (book std pages, slice of epic #582; dependency #585 is merged), no duplicate, no design-record collision, no seed impact. Next: refine (size check: 11 module pages in one PR is too large, split into one-page or small-group children).
Author
Collaborator

[loop:torbscript] claim refine by session:loop-torbscript-20261030 until 2026-10-30T06:10Z

[loop:torbscript] claim refine by session:loop-torbscript-20261030 until 2026-10-30T06:10Z
Author
Collaborator

[loop:torbscript] release refine: the old material of the eleven modules is about 143 KB, too much for one PR; filed #646 (encoding), #647 (json-schema), #648 (toml, yaml), #649 (xml), #650 (html), #651 (markdown, compression), #652 (binary, archive), #653 (uri), each one page or two, 30-40 minutes, with the criteria of this issue and its own Replaces in docs/ list. #592 now carries the checklist and no ready. All children carry loop and none is ready; #649 waits for the PR of #605 (it edits docs/standard-library/xml.md).

[loop:torbscript] next: waiting (children #646, #647, #648, #649, #650, #651, #652, #653)

[loop:torbscript] release refine: the old material of the eleven modules is about 143 KB, too much for one PR; filed #646 (encoding), #647 (json-schema), #648 (toml, yaml), #649 (xml), #650 (html), #651 (markdown, compression), #652 (binary, archive), #653 (uri), each one page or two, 30-40 minutes, with the criteria of this issue and its own `Replaces in docs/` list. #592 now carries the checklist and no `ready`. All children carry `loop` and none is `ready`; #649 waits for the PR of #605 (it edits docs/standard-library/xml.md). [loop:torbscript] next: waiting (children #646, #647, #648, #649, #650, #651, #652, #653)
Author
Collaborator

[loop:torbscript] wait until 2026-10-30T09:00Z: children #646 to #653 are filed and not ready; four PRs (#655, #663, #635, #601) are open with CI still pending in the congested forge queue. Next: make #646 ready once one of them has merged or its CI has finished (#649 only after #637, which is merged, so it is free too).

[loop:torbscript] wait until 2026-10-30T09:00Z: children #646 to #653 are filed and not ready; four PRs (#655, #663, #635, #601) are open with CI still pending in the congested forge queue. Next: make #646 ready once one of them has merged or its CI has finished (#649 only after #637, which is merged, so it is free too).
Author
Collaborator

[loop:torbscript] wait until 2026-10-30T09:00Z: #646 (encoding) is ready and claimed by a worker; #647 to #653 stay unready while PRs #601, #655, #663 and the new #646 PR clear the forge CI. Next: make the next child ready once one of them has merged.

[loop:torbscript] wait until 2026-10-30T09:00Z: #646 (encoding) is ready and claimed by a worker; #647 to #653 stay unready while PRs #601, #655, #663 and the new #646 PR clear the forge CI. Next: make the next child ready once one of them has merged.
Sign in to join this conversation.
No labels
loop
ready
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Reference
torbscript/language#592
No description provided.