book: Guide, coming from another language #588
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
#608 book: Guide, coming from Go and Python (slice of #588)
torbscript/language
Reference
torbscript/language#588
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
book/guide/coming-from/, one page per language, replacingdocs/guide/coming-from/*anddocs/explanation/coming-from-*.md: Go, Kotlin and Swift, Python, Rust, TypeScript and JavaScript, plus an index.Acceptance 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)go,pythonand so on blocks; only the TorbScript side runsChapters
Filed one at a time, each as its own issue when the one before it has landed (just in time). The folder
book/guide/coming-from/and its index come with the first.docs/guide/coming-from/rust.md,typescript-javascript.md,docs/explanation/coming-from-rust.md,coming-from-typescript.md)docs/guide/coming-from/kotlin-swift.md,docs/explanation/coming-from-kotlin.md,coming-from-swift.md; the last slice also deletes the olddocs/guide/coming-from/index.mdand the links to it)[loop:torbscript] intake: in scope (book guide chapter, slice of epic #582 via #587), no duplicate, blocks #1. Next: refine.
[loop:torbscript] claim refine by session:loop-torbscript-20261029-0858 until 2026-10-30T02:50Z
[loop:torbscript] release refine: split just in time. Five language pages plus an index and the deletion of ten old pages with the skill regeneration are more than one 30-40 minute PR, so the work is three slices: Go and Python with the folder and its index (filed as #608, labels loop and ready), then Rust with TypeScript and JavaScript, then Kotlin and Swift (filed when the one before has landed; the last one also retires the old coming-from index).
Dependencies: #588 depends on #585 (merged), #608 and #607. #608 also depends on #607, because both change the generated list in
book/guide/index.mdand regenerate the same skills (skills/torbscript), so they would conflict if they ran side by side. #588 itself stays withoutready; it is the parent of the slices. Open point for the implementer of #608:book/has no nested guide folder yet, so the acceptance asks to check that the site generator handlesguide/coming-from/and to fix it in a separate commit if not.next: waiting (#607), then implement #608.
[loop:torbscript] wait until 2026-10-30T09:00:00Z: #608 landed (PR #635). The next slice (Rust, TypeScript and JavaScript) is filed just in time once forge CI drains: PRs #601, #655 and #663 are queued or red on a congested runner, so another book PR now only lengthens the queue. next: refine the Rust and TypeScript slice when a PR has merged.