Changelog¶
This guide is updated with every release of CherryLedger. The most recent changes are at the top.
For maintainers
When you change the system, update the affected guide page(s) and their screenshots in the same
change, add an entry here, and redeploy the docs (./deploy.sh rebuilds and publishes them). See
Keeping the docs current.
Unreleased¶
- Reports. New Reports screen with 21 standard reports across Production (daily collections, delivery register, member/factory production, clerk activity, reversals, manual & unstable weights), Membership (member register, dormant members), Finance (season summary, season prices, member earnings & balances, advances, deductions, farm inputs, sales, payout runs, payout register, bank disbursement list) and Compliance (audit trail, SMS log). Each runs on screen and exports to PDF and CSV; the list only shows the reports your role may run. See Reports.
- SMS management screen. New SMS page: a dashboard (balance, sent/delivered/pending/failed, today, units, delivery rate), full sent-SMS history with delivery-status tracking, manual send to members/all/phone numbers, and (admins) provision account + top up units. Each cooperative has its own gateway account and balance. See SMS.
- SMS notifications now send through the ShuleOne SMS gateway (
sms.shuleone.co.ke) instead of a stub. Enable withSMS_ENABLED=trueand a gateway API key. Each cooperative (and optionally each factory) can set its own approved SMS sender ID on its Edit form; those without one fall back to the defaultWALGOTECHSC. - Move user to another cooperative. Super Admins can reassign a user to a different cooperative from the Users screen (their old-cooperative factories are cleared). See Users & invitations.
- Farm inputs (store credit). New screen for Store Keepers to issue fertiliser and other inputs on credit; each issue auto-creates an input-credit deduction recovered at payout. See Farm inputs.
- Advances & deductions screen. New finance screen with permission-gated Advances and Deductions tabs — issue advances and record deductions (input credit, loan, levy, other) against a member for the selected season. See Advances & deductions.
- Tenant isolation tightened. Non–super-admins see only their own cooperative and no longer see (or can act on) super-admin accounts.
- Cooperative management. New Cooperatives screen for Super Admins to create and manage cooperatives, and a Cooperative selector on the Add User form so a new cooperative can be given its own administrator. See Cooperatives.
- Invitations tightened. Invitation links now expire in 24 hours and are strictly single-use. See Users & invitations.
- Email delivery. Staff invitations are sent by email via the cooperative's mail server.
Earlier¶
- Sales → realised price. Record sales and apply the realised rate as the season's final price, flipping member statements from provisional to realised. See Sales.
- Member statements (PDF). Per-member season statements with priced deliveries, advances, deductions and net payable. See Member statements.
- Finance — pricing, advances, deductions, payouts. Season pricing plus the compute → approve → disburse payout flow with a bank-list export. See Payouts.
- Multi-factory & active-factory context. Users can operate several factories, switching with the header selector, with data scoped per factory.
- Phase 1. Cooperative → factory → member hierarchy, permission-based roles, automated weighing, receipts, and the farmer portal.
Keeping the docs current¶
This site is a small MkDocs Material project (cherryledger-docs/). To update it:
- Edit the relevant page(s) under
docs/(plain Markdown). - Re-capture any screen that changed into
docs/assets/shots/(keep the same filename). - Add a note here under Unreleased.
- Preview locally with
mkdocs serve, then publish with./deploy.sh(which rebuilds the docs and deploys them todocs.cherryledger.co.ke).
Treat a system change as incomplete until its documentation is updated — the same discipline the project applies to its handover notes.