Produce the complete API reference for the shade contract's public interface — every function in ShadeTrait with its signature, parameters, return value, authorization, errors, and emitted events. This is the page integrators will keep open while building.
Proposed steps:
- Create
docs/reference/shade-interface.md.
- For every function in
contracts/shade/src/interface.rs, document: exact signature, a one-line summary, each parameter with its meaning and units, the return value, required authorization, preconditions, panics/errors, and events emitted.
- Organise by domain (admin/config, merchant, invoice, payment, fee, subscription, ticketing, analytics, security) with an alphabetical index at the top for lookup.
- Include a short usage snippet for each non-trivial function showing a CLI invocation.
- Add a stability note per function where behaviour is expected to change (e.g. payload/bridge functions).
- Document a maintenance rule requiring this page to be updated in the same PR as any
ShadeTrait change, and note it in the docs style guide.
Acceptance criteria:
docs/reference/shade-interface.md exists and covers 100% of the functions declared in ShadeTrait.- Every entry lists authorization, errors, and events.
- An alphabetical index links to every entry.
- The update-with-interface-changes rule is documented in the style guide and
CONTRIBUTING.md.
Produce the complete API reference for the
shadecontract's public interface — every function inShadeTraitwith its signature, parameters, return value, authorization, errors, and emitted events. This is the page integrators will keep open while building.Proposed steps:
docs/reference/shade-interface.md.contracts/shade/src/interface.rs, document: exact signature, a one-line summary, each parameter with its meaning and units, the return value, required authorization, preconditions, panics/errors, and events emitted.ShadeTraitchange, and note it in the docs style guide.Acceptance criteria:
docs/reference/shade-interface.mdexists and covers 100% of the functions declared inShadeTrait.CONTRIBUTING.md.