Documentation · page arrangement
Two-column reference
Name and type on the left, what it means on the right. Choose it for the page nobody reads and everybody searches.
- 1Navigation
- 2Receipt fields
- 3Footer
Receipt fields
- receipt.idstring
- Unique per till. Never reused, even after a refund.
- receipt.totalinteger
- In cents. Never a decimal, to avoid rounding drift.
- receipt.lines[]array
- One entry per product sold, with quantity and unit price.
- receipt.paid_withenum
- cash · card · split · account
- receipt.offlineboolean
- True if the sale was taken with no network.
- receipt.synced_attimestamp | null
- Null until the account confirms it.
- stock.on_handinteger
- Can go negative after two offline tills sell the same item.
- stock.counted_attimestamp
- When a human last counted this product.
The other four arrangements for a documentation
Same fictitious business, same content, arranged four other ways. How does it work, and where is the answer to my question?
Sidebar and article
Every page in a tree on the left, the answer on the right. The arrangement people expect from documentation, and the right default.
Documentation · 3 sections
Card landing
Six doors instead of a tree. Choose it for the front page of a set of guides, where a sidebar is premature.
Documentation · 5 sections
Questions, folded
Questions you can scan, answers you open. Choose it when there are twelve questions and no structure between them.
Documentation · 5 sections
Changelog
Versions newest first, with what broke. Choose it when people need to know what changed since they last looked.
Documentation · 4 sections