Skip to content

docs(web): full documentation set and API reference - #140

Merged
manish-9245 merged 1 commit into
mainfrom
docs/api-reference
Oct 24, 2026
Merged

manish-9245 merged 1 commit into
mainfrom
docs/api-reference

Conversation

@manish-9245

@manish-9245 manish-9245 commented Oct 24, 2026 •

Copy link
Copy Markdown
Contributor

Rewrites the website docs from what the code does today: install, first payment, how it works, dashboard, orders and pay links, review, refunds, reconciliation, languages and voice, AI help, backups and keys, connect pages (Android, bank email, Mac, banks, WooCommerce, Shopify), API, webhooks, CLI, configuration, states and ledger, operations, security, troubleshooting and FAQ.

Corrects earlier claims that were wrong (there is no make-dev demo data or runnable simulator scenarios yet, sign-in is TOTP not passkeys). Each page marks what is built but not yet connected. openapi.yaml gains the missing 401/404/413 responses.

Requested by the maintainer in chat; refs #138.

Summary by CodeRabbit

  • Documentation
    • Expanded the guides for installation, first payments, orders, alert sources, refunds, reconciliation, dashboard use and security.
    • Added references for the API, CLI, configuration, operations, webhooks, ledger states and troubleshooting.
    • Clarified which features are available, planned or still being connected, including Android and Mac forwarding, email checking and AI features.
  • API
    • Documented additional error responses and the order returned when cancellation succeeds.

@manish-9245
manish-9245 requested a review from scoder5 as a code owner October 24, 2026 11:16
@manish-9245

Copy link
Copy Markdown
Contributor Author

@coderabbitai full review

@coderabbitai

coderabbitai Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Caution

Review failed

The pull request is closed.

Walkthrough

This PR expands documentation for setup, payment workflows, alert sources, everyday use and technical operations. It also updates the OpenAPI specification with additional order endpoint responses. The documentation distinguishes available components from planned or not-yet-connected components.

Changes

Product documentation and API contract

Layer / File(s) Summary
Getting started and first payment
web/src/content/docs/docs/index.md, web/src/content/docs/docs/start/*
The index and start guides describe the documented setup path, deployment options and a first-payment walkthrough.
Alert sources and bank recognition
web/src/content/docs/docs/connect/*
The connection guides describe Android forwarding, bank email and a planned Mac agent. The supported-bank guide documents sender matching, parsed fields and unrecognised messages.
Orders, decisions and reconciliation
web/src/content/docs/docs/use/orders-and-links.md, web/src/content/docs/docs/use/needs-your-ok.md, web/src/content/docs/docs/use/refunds.md, web/src/content/docs/docs/use/reconciliation.md, web/src/content/docs/docs/reference/ledger-and-states.md
These guides document order amounts and states, held-payment decisions, refund rules, reconciliation and ledger behaviour.
Dashboard and everyday guidance
web/src/content/docs/docs/use/dashboard.md, web/src/content/docs/docs/use/languages-and-voice.md, web/src/content/docs/docs/use/ai-features.md, web/src/content/docs/docs/use/backup-and-keys.md
The pages document dashboard access and status, language and voice, AI feature limits, and backup and key guidance.
API and operational references
openapi.yaml, web/src/content/docs/docs/reference/*
The OpenAPI specification adds order endpoint responses. The reference pages describe the API, webhooks, CLI, configuration, security, operations, troubleshooting and FAQ topics.

Estimated code review effort: 3 (Moderate) | ~25 minutes

Change: Other

Possibly related issues

  • opensawce/kaasu#6 — The OpenAPI response updates add documentation for order endpoint authentication, not-found and request-size responses.
  • opensawce/kaasu#19 — The Android forwarding guide documents the pairing and signed-ingest protocol described by this issue.
  • opensawce/kaasu#17 — The bank email guide documents IMAP, DKIM verification and payment matching.
  • opensawce/kaasu#16 — The supported-bank guide covers sender filtering, parsing and unknown formats.
  • opensawce/kaasu#8 — The ledger and state documentation describes the order lifecycle and transitions.
  • opensawce/kaasu#48 — The reconciliation guide describes statement column mapping and validation.
  • opensawce/kaasu#46 — The AI guide documents provider availability, masking, consent and feature controls.
  • opensawce/kaasu#31 — The held-payment guide describes review decisions and their restrictions.
  • opensawce/kaasu#51 — The setup and first-payment documentation describes current demo and simulator availability.

Possibly related PRs

  • opensawce/kaasu#94 — This PR documents the order API routes and adds their responses to the OpenAPI specification.
  • opensawce/kaasu#101 — This PR documents the device pairing and signed-ingest contract implemented in that PR.
  • opensawce/kaasu#105 — This PR documents webhook delivery, signature checks, retries and destination restrictions implemented in that PR.
Merge Risk: Moderate · up to 0019d

The documentation needs corrections before merging: fresh setups can stall, installation instructions leave verification and key-handling gaps, and the restore procedure can discard newer records. Payment and security guidance also needs narrower, accurate guarantees.

- [ ] Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

@manish-9245
manish-9245 merged commit 344d15d into main Oct 24, 2026
20 of 21 checks passed
@manish-9245
manish-9245 deleted the docs/api-reference branch October 24, 2026 11:26
@coderabbitai

coderabbitai Bot commented Oct 24, 2026 •

Copy link
Copy Markdown
⚠️ Action not completed

Pull request is closed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant