Repository navigation

Add a tutorial, an approachable README and current-state docs - #32

Merged

christianparpart merged 41 commits into

masterfrom

docs/approachable-readme-and-tutorial

Oct 6, 2026

Commits on Oct 6, 2026
- docs: design an approachable README, a tutorial, and current-state docs
  Christian Parpart
  committed
  d6aaf2e
- docs: plan the approachable README, tutorial and current-state docs
  Christian Parpart
  committed
  a91656c
- test: pin an example's whole output to a checked-in file
  Christian Parpart
  committed
  8f589c0
- docs: include tutorial code from compiled programs, and build the site on PRs
  Christian Parpart
  committed
  00906cf
- test: read pinned output as UTF-8, and refuse a non-.cpp source
  Christian Parpart
  committed
  bd1284b
- docs: add tutorial chapter 1, a first formula
  Christian Parpart
  committed
  f7dd904
- docs: dedent code regions included from inside a function
  Christian Parpart
  committed
  6ad6e56
- docs: add tutorial chapters on units and on exact numbers
  Christian Parpart
  committed
  a4279e1
- docs: link chapter 2's reuse of a bound formula to its guide section
  Christian Parpart
  committed
  7a130ba
- docs: describe dimensions and exactness accurately in chapters 2 and 3
  Christian Parpart
  committed
  aad838d
- docs: add tutorial chapters on missing values and on rounding
  Christian Parpart
  committed
  596a69d
- docs: correct the rounding mode wording in tutorial chapters 4 and 5
  Christian Parpart
  committed
  e71d380
- docs: add tutorial chapters on constraints and on documentation
  Christian Parpart
  committed
  71a5f50
- docs: say what chapter 7's rendering and symbol table cover
  Christian Parpart
  committed
  1c796c1
- docs: point chapter 7 to the guide for a calculation's symbol table
  Christian Parpart
  committed
  a184db6
- docs: add tutorial chapters on tracing and on worksheets
  Christian Parpart
  committed
  f72126a
- docs: add tutorial chapters on lookup tables and on methods
  Christian Parpart
  committed
  6b7d4b1
- docs: add tutorial chapters on series and on statistics
  Christian Parpart
  committed
  3faf8c1
- docs: show the overlay changing a number in tutorial chapter 11
  Christian Parpart
  committed
  e98eec7
- docs: say why chapter 12 enters the 28-day strength on its own
  Christian Parpart
  committed
  ecd898b
- docs: add tutorial chapters on records and on opaque operations
  Christian Parpart
  committed
  9702c67
- docs: say which retry ends the outcome reports in tutorial chapter 15
  Christian Parpart
  committed
  4979327
- docs: rewrite the README as a short landing page
  Christian Parpart
  committed
  c0c95fb
- docs: make the site's home page a short entry point
  Christian Parpart
  committed
  4a8b7ae
- test: fail when the README or tutorial fetches another release
  Christian Parpart
  committed
  8fd6493
- test: add a check that user documentation describes only the present
  Christian Parpart
  committed
  f32a06a
- test: make the current-state check see emphasis and refuse unused allowances
  Christian Parpart
  committed
  2f42f24
- chore: use the Apache License 2.0 text verbatim
  Christian Parpart
  committed
  5428b90
- docs: describe the library as it is now, and enforce it
  Christian Parpart
  committed
  6b96f9c
- ci: measure the library's test coverage and report it to Codecov
  Christian Parpart
  committed
  d81ea78
- docs: document the documentation rules, and record this change
  Christian Parpart
  committed
  76445fa
- docs: correct the changelog's home-page entry and two contributing facts
  Christian Parpart
  committed
  06ee72a
- docs: state the present in the comments and guides the check cannot read
  Christian Parpart
  committed
  8fda7eb
- docs(headers): state the present in the remaining history comments
  Christian Parpart
  committed
  fc5ca7f
- docs: describe the present in the guides and correct tutorial details
  Christian Parpart
  committed
  6183045
- docs: sharpen the README's pitch, example and CI facts
  Christian Parpart
  committed
  8848d6b
- feat(yields): a bound formula is an operand, standing for its formula
  Christian Parpart
  committed
  21fa342
- ci: upload coverage only when the Codecov token is set
  Christian Parpart
  committed
  c25662a
- fix(yields): a bound operand answers a concept's probe as its formula does
  Christian Parpart
  committed
  6b67800
- docs: use a bound formula directly inside another formula
  Christian Parpart
  committed
  d461ebe
- docs: tighten the wording on using a bound formula inside another
  Christian Parpart
  committed
  5959623

Commits

Commits on Oct 6, 2026