book: Std pages, io, path, console (slice of #593) #656
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 #593 (Std pages, system and I/O), which is a slice of the epic #582. Starts after nothing; #585 is merged. The other Std slices (#591, #592, #594, #595) and the Guide and Reference slices are independent of this one. Governing note:
book/CONCEPT.md("How a page is written", "What CI checks"). Touches the seed: no (documentation only; no syntax change, no native, no driver flag, no std name looked up by the compiler).Goal
Write the Std page(s)
book/std/io.md,book/std/path.md,book/std/console.md. Read likebook/std/json.md(merged in #585): the 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 a real program and its output. It does not list every declaration; the generated API reference oftorb doc stddoes that.Replaces in
docs/docs/standard-library/io.mddocs/standard-library/path.mddocs/standard-library/console.mdAcceptance criteria
page,status: stable, front matter in the shape ofbook/std/json.md(title,summary,order,package; the summary within thedocs checklimit), names its module (package: std/io,package: std/path,package: std/console), and is written asbook/CONCEPT.md, "How a page is written", says: the first paragraph says in two to four sentences what the page covers, headings name ideas, prose first, no history words, no internal references (no issue numbers, no links intodocs/design,docs/contributing,docs/internals,CONCEPT.md), no Related/Next/See also sections, lists of at most seven items, every section starts with a sentence; links only to book pages that exist on maintrb runandtrb errorblock is followed by itsoutputblock with the real output (atrb errorblock shows whattorb checkprints, fromerror:on); no fragments, no// printscommentsbook/CONCEPT.mdthat the area touches are shown, not just namedbook/std/index.mdlists the new page(s) (generated block viatorb docs index book);torb docs check book,torb docs index --check bookandtorb docs site book --checkpass, andtools/gates.shpasses in CIdocs/" are deleted in the same PR unless a skill is still built from them (skills are generated bytorb docs skill docs skills): for every old page a skill still needs, it stays indocs/unpublished and the PR description names it and why; the others are deleted together with every link to them, and the skills are regenerated sodocs skill --checkstays greenNotes for the implementer
book/CONCEPT.md,book/std/json.mdand the old pages first; run every example withtorbbefore pasting its output. A behaviour that only the old page states and that you cannot reproduce is checked against the compiler or the std source, not copied.docs(book): std ioand, if needed,docs: retire the pages the std pages replace.