Documentation
Technical documentation for understanding, operating, extending, and forking Deflation Ratchet.
Documentation index
- Architecture: major components and their responsibilities.
- Data model: products, variants, offers, observations, purchases, and provenance.
- Retrieval: automatic, adapter-based, manual, and user-assisted acquisition.
- Events: stable machine-readable events emitted by the system.
- Invariants: rules future code and forks should preserve.
- File formats: JSON and CSV exports and future interchange formats.
Vocabulary
- Product family
- A general product concept shared by one or more variants.
- Product variant
- A specific size, capacity, model, package, or other purchasable variation.
- Offer
- A merchant's listing or purchasable offer for a product variant.
- Price observation
- A historical record of an offer's observed state at a particular time.
- Provenance
- Information describing where an observation came from and when it was observed.