LendAPI documentation (source)

Client-facing documentation site built with VitePress. Published structure follows a Guides / API / Changelog split (similar in spirit to developer-doc sites like Moov), optimized for dashboard users first and integrators second.

Last updated: 2026–05-27

---

Site sections

Top nav	Purpose	Entry
Guides	Dashboard how-tos: screens, workflows, roles	guides/index.md
Use cases	Cross-module scenarios (stub; deep dives live in Guides today)	use-cases/index.md
API	REST reference for developers (stub until OpenAPI publish)	api/index.md
Changelog	Product + doc updates by release	release-notes/index.md

• Guides use the left sidebar grouped by product area (Agent Dashboard, Product Studio, Rules Studio, Email & SMS, etc.).
• API will eventually hold versioned endpoint reference; until then, see API keys/webhooks under Guides and _meta.md for route mapping.
• Changelog is driven by release-notes/index.md (docs-automation) plus CHANGELOG.md for documentation-only edits.
• Versioning: Per-page lastVerified frontmatter, release notes for product changes, and versioning-and-updates.md for the editorial process.

---

Local commands

cd docs
npm install
npm run dev      # http://localhost:5173
npm run build
npm run preview
npm run check:docs-sync   # doc folder ↔ code map (monorepo root script)

Typography: Open Sauce Sans (loaded in .vitepress/config.mts).

---

Authoring

• Page template: _templates/page-frontmatter.md
• “Related technical resources” cards: _templates/related-technical-resources.md
• Doc ↔ product map: _meta.md
• Screenshots: docs/images/ (see images/README.md in this folder)

Drift check: from monorepo root, node docs-automation/check-docs-sync.js (or npm run check:docs-sync in this folder).

---

Documentation map (doc ↔ build)

Guide section	Backend mount	v2 UI (lend-frontend-repo)	Notes
Getting started	profiles/	Login, profile	Roles, tenant context
Applications	application/	/application/applications/, detail	List, underwriting, offers, history, documents, assign, tags
Customers	customers/	/application/customers/	List, detail, block
Tenant & workspace	tenant/, profiles/, billing/, sso/	/settings/workspace/, /stats/, /tenants/	Dashboard, API keys, webhooks, branding
Pricing Engine	offer/	/pricing-engine/	Offer tables CRUD, versions
Rules & decisions	rules/, workflow/	/rules/, /decision-outcomes/	Rules studio, outcomes
Templates	emails/	/templates/	Email & SMS
Products	products/, page_builder/	/product-studio/, /model-studio/	Product catalog, wizard, model studio
Documents & contracts	docs/	/docs/contracts/, /docs/doc_lib/	Library, contracts, upload templates
Leads & marketplace	leads/, campaign/	/lead-gen/	Campaigns, sources