Clipp Docs

How Clipp works for suppliers, one feature at a time. Each page describes what people see in the app, on documents and in messages, using the app's own wording.

How the docs are organised

There are three levels: area, then module, then feature page. There is never a fourth level. When a feature page grows too big, it splits into sibling pages.

• Concepts hold rules that apply across many modules, such as catch-weight, money and rounding, or dates and time zones. Feature pages link to a concept instead of repeating it.
• Seven feature areas follow, in sidebar order: Orders, Billing & payments, Catalog, Customers, Purchasing, Finance, and Account & team. Concepts sit last as shared reference.
• Each module opens with an Overview page. Its feature pages and its specs sit in the same folder.

Pages and specs

Each feature folder holds two kinds of file:

• Pages (.md) explain what the feature does and why, how it calculates, and where it shows up.
• Specs (.feature) are Gherkin scenarios that cover every edge case. Every scenario has an ID, such as IMM-006, and tests cite that ID.

A page shows a spec by linking to it on a line of its own. The site renders the linked file in place, and the link still works on GitHub.

Writing a page

Start from the page template.