Appearance
Doc ↔ build mapping (source of truth for drift checks)
This file is used by docs-automation/check-docs-sync.js and the docs-intel pipeline to keep VitePress documentation aligned with the product build.
Last updated: 2026–05-26
Code sources (not lend-api-sim):
| Layer | Path |
|---|---|
| v2 frontend routes | lend-frontend-repo/src/lib/constants/routes.ts |
| v2 frontend router | lend-frontend-repo/src/features/LendAPIApp.tsx |
| v2 feature modules | lend-frontend-repo/src/features/<name>/ |
| Django URL mounts | repo/lendapi/urls.py |
| Per-app routes/APIs | repo/<app>/urls.py (e.g. repo/application/urls.py) |
Doc section ↔ product areas
| Doc folder | Backend mount | Frontend feature(s) | v2 route prefixes (sample) | Required doc |
|---|---|---|---|---|
docs/getting-started/ | profiles/ | — | /login/, /profile | yes |
docs/applications/ | application/ | applications | /application/applications/, /application/detail/ | yes |
docs/customers/ | customers/ | customers | /application/customers/ | yes |
docs/tenant-and-workspace/ | tenant/, profiles/, billing/, sso/ | settings, dashboard, tenants | /settings/workspace/, /stats/, /tenants/ | yes |
docs/pricing-engine/ | offer/ | pricing-engine | /pricing-engine/ | yes |
docs/rules-and-decisions/ | rules/, workflow/ | rules-studio, decision-outcomes | /rules/, /decision-outcomes/ | yes |
docs/templates/ | emails/ | templates | /templates/ | yes |
docs/products/ | products/, page_builder/ | product-studio, model-studio | /product-studio/, /model-studio/ | yes |
docs/documents-and-contracts/ | docs/ | contract-builder, doc-library, doc-upload-templates | /docs/contracts/, /docs/doc_lib/, /doc-upload-templates/ | yes |
docs/leads-and-marketplace/ | leads/, campaign/ | lead-gen | /lead-gen/ | yes |
| (optional — no doc folder) | provider/ | integrations | /integrations/, /provider/providers | no |
| (optional — no doc folder) | flow_builder/ | workflow-builder | /flow-builder/ | no |
| (optional — no doc folder) | backtest/, abtest/, shadowtest/ | backtest, abtest, shadowtest | /backtest/, /abtest/, /shadowtest/ | no |
| (optional — no doc folder) | lender/ | lenders | /lenders/ | no |
| (optional — no doc folder) | labs/ | labs | /labs/ | no |
| (optional — no doc folder) | kyb/ | — | /kyb/ | no |
| (optional — no doc folder) | applicant/ | applicant | /applicant/ | no |
| (optional — no doc folder) | api/v1/ | — | REST v1 (external) | no |
API prefix notes (dashboard v2)
Mounted under Django repo/lendapi/urls.py. Representative JSON API paths (full paths are <mount>api/...):
| Area | Example API path (after site root) |
|---|---|
| Applications | application/api/applications/, application/api/app/<session>/detail/ |
| Customers | customers/api/... (see repo/customers/urls.py) |
| Tenant / profile | tenant/api/..., profiles/api/... |
| Pricing | offer/api/offer_tables/... |
| Rules | rules/api/... |
| Templates | emails/api/... |
| Products | products/api/... |
| Documents | docs/api/... |
| Leads | leads/api/... |
Non-doc paths under docs/
These directories/files are not VitePress content. Ignored by check-docs-sync.js:
images/— static assetsnode_modules/— local npm install (should not be committed)migrations/,static/— legacy artifacts; do not treat as doc sections
Versioning
- Each doc page should include frontmatter (see
docs/_templates/page-frontmatter.md). - Doc-wide changes are recorded in CHANGELOG.md.