ADI-JAYA Documentation
WELCOME. This documentation is created so that junior maintainers can handle the system safely without guessing at the source code.
Quick Summary
If you're just starting out, follow the onboarding sequence. If you find parts that are uncertain, note them in the Verification Matrix.
Start here (order required)
- Onboarding Junior
- Day 1 - Day 3 Onboarding
- Onboarding Checklist
- Overview
- Top 10 Important Files
- Common Maintenance Tasks
- Troubleshooting
Important shortcuts (quick wins)
- Single source item requires verification → verification-matrix
- Real change example + rollback → change-example-pack
- Docs verification status guide → verification-guideline
Where to find X
- Want to understand the system from scratch → overview, architecture, end-to-end-process
- Want to know what API the team uses → api-reference
- Want a complete endpoint list (audit) → api-full-catalog
- Want ready-made request/response examples → api-examples, request-response-catalog
- Want to check legal business status → state-machine
- Want to check table relations quickly → database-viewer
- Want a complete table inventory → database-full-catalog
- Want to change secure schema/data → change-data-playbook, change-example-pack
- Want to deploy/operate → deployment-runbook, observability-ops
Working principles of junior maintainers
- Safe first, fast later.
- Always verify before and after changes.
- Data changes must be reversible (at least there is a backup/rollback plan).
- Don't merge just because "it works locally".
- If something is uncertain, mark requires verification in Verification Matrix then escalate.
Full coverage catalog (for audits)
- Database Full Catalog: /docs/database-full-catalog
- API Full Catalog: /docs/api-full-catalog
Use these two documents when you need a complete inventory (not a curated summary).