book: Guide chapters (first project, modelling data, collections, files and formats, testing, native programs, design choices) #587
Labels
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Blocks
Depends on
#599 book: retire the human pages of docs/
torbscript/language
#585 docs(book): a book for people, and the site built from it
torbscript/language
#607 book: Guide chapter first project (slice of #587)
torbscript/language
Reference
torbscript/language#587
Loading…
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Slice of the epic #582. Starts after #585 (the concept, the vertical slice and the book gates) is merged.
Scope
Write the remaining chapters of
book/guide/, each about one kind of task, read in any order:docs/guide/first-project.mdguide/installing-and-running.md,guide/a-small-program.md,how-to/set-up-a-workspace.md,how-to/add-a-dependency.mdguide/modelling-data.mdlanguage/types/data-or-capsule.md,how-to/write-a-builder.md,how-to/use-a-type-as-a-map-key.md,how-to/convert-between-types.mdguide/working-with-collections.mdhow-to/collect-a-pipeline.md,how-to/sort-by-more-than-one-key.md, the rest ofguide/collections-and-pipelines.mdguide/files-and-formats.mdhow-to/read-a-file.md,how-to/read-and-write-json.mdguide/testing.mdhow-to/write-a-test.mdguide/native-programs.mdhow-to/build-a-native-binary.md,language/extensibility/foreign-functions.mdguide/design-choices.mdguide/idiomatic-torbscript.md,explanation/why-*.md,explanation/where-are-my-overloads.mdAcceptance criteria
pageand is written asbook/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 sectionstrb runandtrb errorblock has itsoutputblock with the real output;torb docs check book,torb docs index --check bookandtorb docs site book --checkpass in CIbook/CONCEPT.mdthat the area touches are shown, not just nameddocs/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)guide/design-choices.mdhas one short section per choice, each with the reason in a sentence and an example, no comparison tables of other languagesChapters
Filed one at a time, each as its own issue when the one before it has landed (just in time).
guide/first-project.md- #607 (merged)guide/modelling-data.md- #636 (ready)guide/working-with-collections.mdguide/files-and-formats.mdguide/testing.mdguide/native-programs.mdguide/design-choices.md[loop:torbscript] intake: in scope (slice of epic #582, its blocker #585 is merged), no duplicate, no owner question, no design-record collision. Seven chapters are more than one PR that lands as one or two commits, so the refine worker splits it just in time and files the first chapter as its own ready issue.
[loop:torbscript] claim refine by session:loop-torbscript-20261029-0858 until 2026-10-29T23:40:00Z
[loop:torbscript] release refine: split just in time; first step filed as #607 (ready), remaining chapters follow as each lands. next: waiting (#607)
[loop:torbscript] refine: filed #636 (guide/modelling-data.md, ready) as the next chapter after #607 (merged); checklist updated. Remaining chapters are filed just in time when a slot and the ready buffer allow.
next: waiting (#636)