hamid
64 lines
9.7 KiB
HTML
64 lines
9.7 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<title>product/ — Balinyaar product & domain knowledge — Balinyaar docs</title>
|
|
<link rel="stylesheet" href="assets/doc.css">
|
|
</head>
|
|
<body>
|
|
<div class="layout">
|
|
<aside class="sidebar">
|
|
<a class="brand" href="index.html"><span class="dot"></span> Balinyaar docs</a>
|
|
<p class="tagline">Trust-first home-nursing marketplace · Iran</p>
|
|
<nav><div class="group"><div class="label">Start here</div><ul><li><a href="index.html">Docs home</a></li><li><a href="overview/platform-summary.html">Platform summary & ground truths</a></li></ul></div><div class="group"><div class="label">Business requirements</div><ul><li><a href="business/index.html">Overview & MVP scope</a></li><li><a href="business/01-actors-and-onboarding.html">1. Actors & onboarding</a></li><li><a href="business/02-nurse-verification.html">2. Nurse verification</a></li><li><a href="business/03-service-catalog-and-pricing.html">3. Service catalog & pricing</a></li><li><a href="business/04-search-and-matching.html">4. Search & matching</a></li><li><a href="business/05-booking-and-scheduling.html">5. Booking & scheduling</a></li><li><a href="business/06-evv-and-service-delivery.html">6. EVV / service delivery</a></li><li><a href="business/07-cancellation-and-refunds.html">7. Cancellation & refunds</a></li><li><a href="business/08-payments-and-escrow.html">8. Payments & escrow</a></li><li><a href="business/09-installments-bnpl.html">9. Installments / BNPL</a></li><li><a href="business/10-payouts.html">10. Payouts to nurses</a></li><li><a href="business/11-reviews-trust-and-safety.html">11. Reviews, trust & safety</a></li><li><a href="business/12-messaging-and-emergencies.html">12. Messaging & emergencies</a></li><li><a href="business/13-tax-invoicing-and-legal.html">13. Tax, invoicing & legal</a></li><li><a href="business/14-notifications-and-admin.html">14. Notifications & admin</a></li></ul></div><div class="group"><div class="label">Database model</div><ul><li><a href="data-model/index.html">Overview & decisions</a></li><li><a href="data-model/diagrams.html">Diagrams</a></li><li><a href="data-model/01-identity-and-access.html">1. Identity & access</a></li><li><a href="data-model/02-geography.html">2. Geography</a></li><li><a href="data-model/03-services-and-pricing.html">3. Services & pricing</a></li><li><a href="data-model/04-verification-and-credentials.html">4. Verification & credentials</a></li><li><a href="data-model/05-booking-and-scheduling.html">5. Booking & scheduling</a></li><li><a href="data-model/06-payments-ledger-and-refunds.html">6. Payments, ledger & refunds</a></li><li><a href="data-model/07-payouts.html">7. Payouts</a></li><li><a href="data-model/08-bnpl.html">8. BNPL / installments</a></li><li><a href="data-model/09-messaging.html">9. Messaging</a></li><li><a href="data-model/10-reviews-and-records.html">10. Reviews & records</a></li><li><a href="data-model/11-notifications.html">11. Notifications</a></li><li><a href="data-model/12-audit-config-and-reference.html">12. Audit, config & reference</a></li><li><a href="data-model/13-partner-centers-and-future.html">13. Partner centers & future</a></li></ul></div><div class="group"><div class="label">Payments deep-dive</div><ul><li><a href="payments/index.html">Overview & exec summary</a></li><li><a href="payments/iranian-payment-reality.html">Iranian payment reality</a></li><li><a href="payments/escrow-ledger.html">Escrow as a ledger</a></li><li><a href="payments/bnpl-landscape.html">BNPL landscape & finding</a></li><li><a href="payments/cancellation-and-payout.html">Cancellation & nurse payout</a></li><li><a href="payments/integration-notes.html">Integration & schema touchpoints</a></li><li><a href="payments/sources.html">Recommendations & sources</a></li></ul></div><div class="group"><div class="label">Research & strategy</div><ul><li><a href="research/index.html">Overview & exec summary</a></li><li><a href="research/market-and-competitors.html">Market & competitors</a></li><li><a href="research/problems-and-risks.html">Problems & risks</a></li><li><a href="research/verification.html">Verification (research)</a></li><li><a href="research/legal-landscape.html">Legal landscape</a></li><li><a href="research/go-to-market.html">Go-to-market & sources</a></li></ul></div><div class="group"><div class="label">Notes & more</div><ul><li><a href="notes/open-questions.html">Open questions</a></li><li><a href="notes/future-ideas.html">Future ideas</a></li><li><a href="wireframes/index.html">Wireframes</a></li><li><a href="fa/index.html">Farsi documents</a></li></ul></div></nav>
|
|
</aside>
|
|
<main class="main"><div class="content">
|
|
<div class="topbar"><button class="theme-toggle" type="button" onclick="__t()">theme</button></div>
|
|
<h1 id="product-balinyaar-product-domain-knowledge"><code>product/</code> — Balinyaar product & domain knowledge</h1>
|
|
<p>This folder is the <strong>source of truth</strong> for Balinyaar's business rules, data model, payments design, and market/legal research. The code is young; <strong>these docs are the decisions</strong>. Read the relevant doc before designing any schema, API, or feature — don't infer business rules from code.</p>
|
|
<blockquote><p><strong>For humans:</strong> open <a href="index.html"><code>index.md</code></a> (or the generated <a href="index.html"><code>index.html</code></a>) — it's the hub that links everything.</p>
|
|
</blockquote>
|
|
<h2 id="layout">Layout <a class="anchor" href="#layout" aria-hidden="true">#</a></h2>
|
|
<div class="table-wrap"><table><thead><tr><th>Path</th><th>What's in it</th></tr></thead><tbody>
|
|
<tr><td><a href="overview/platform-summary.html"><code>overview/</code></a></td><td>What Balinyaar is, the four cross-cutting ground truths, IRR/Toman rule, Persian glossary. <strong>Read first.</strong></td></tr>
|
|
<tr><td><a href="business/index.html"><code>business/</code></a></td><td>The 14 functional requirement areas (onboarding → admin), each with rules / Iran considerations / MVP-vs-deferred / supporting entities.</td></tr>
|
|
<tr><td><a href="data-model/index.html"><code>data-model/</code></a></td><td>The ~54-table schema across 13 domains + <a href="data-model/diagrams.html">diagrams</a>, design principles, design decisions.</td></tr>
|
|
<tr><td><a href="payments/index.html"><code>payments/</code></a></td><td>Fintech deep-dive with sources: payment reality, escrow ledger, BNPL, cancellation/payout, integrations.</td></tr>
|
|
<tr><td><a href="research/index.html"><code>research/</code></a></td><td>Market, risks, verification, legal landscape, go-to-market — adversarially fact-checked, cited.</td></tr>
|
|
<tr><td><a href="notes/open-questions.html"><code>notes/</code></a></td><td>Living notes: <a href="notes/open-questions.html">open questions</a>, <a href="notes/future-ideas.html">future ideas</a>.</td></tr>
|
|
<tr><td><a href="wireframes/index.html"><code>wireframes/</code></a></td><td>Screen wireframes (HTML).</td></tr>
|
|
<tr><td><a href="fa/index.html"><code>fa/</code></a></td><td>Farsi-language docs kept in parallel (research report + verification flow).</td></tr>
|
|
<tr><td><code>assets/</code></td><td>Shared CSS for the generated HTML view.</td></tr>
|
|
</tbody></table></div>
|
|
<h2 id="markdown-is-canonical-html-is-generated">Markdown is canonical; HTML is generated <a class="anchor" href="#markdown-is-canonical-html-is-generated" aria-hidden="true">#</a></h2>
|
|
<p>Every <code>.md</code> file is the editable source. The matching <code>.html</code> files are a <strong>generated</strong>, brand-styled, cross-linked browsing view (sidebar nav, Mermaid diagrams, dark mode). <strong>Never edit the <code>.html</code> by hand</strong> — edit the Markdown and regenerate.</p>
|
|
<h3 id="regenerating-the-html-view">Regenerating the HTML view <a class="anchor" href="#regenerating-the-html-view" aria-hidden="true">#</a></h3>
|
|
<p>The generator is dependency-free — plain Node, no <code>npm install</code>:</p>
|
|
<pre><code>cd product
|
|
node build-docs.mjs</code></pre>
|
|
<p>It walks every <code>.md</code> file, converts it to a styled <code>.html</code> at the same path, builds the sidebar from the manifest inside <code>build-docs.mjs</code>, and rewrites internal <code>…/foo.md</code> links to <code>…/foo.html</code>. If you add, remove, or rename a <code>.md</code> file, update the <code>NAV</code> manifest at the top of <a href="build-docs.mjs"><code>build-docs.mjs</code></a> so it appears in the sidebar.</p>
|
|
<h2 id="conventions">Conventions <a class="anchor" href="#conventions" aria-hidden="true">#</a></h2>
|
|
<ul>
|
|
<li>Each <code>.md</code> starts with a single <code># H1</code> (the generator uses it as the page title).</li>
|
|
<li>Cross-doc links are <strong>relative and use the <code>.md</code> extension</strong> (the generator rewrites them to</li>
|
|
</ul>
|
|
<p> <code>.html</code>); this keeps links working both in raw Markdown and in the rendered site.</p>
|
|
<ul>
|
|
<li>Languages: <strong>English is canonical.</strong> Farsi versions live under <code>fa/</code> and are linked, not inlined.</li>
|
|
<li>Money is <strong>IRR Rials</strong>; see <a href="overview/platform-summary.html">the ground truths</a>.</li>
|
|
</ul>
|
|
<a class="back-to-top" href="#">↑ Back to top</a>
|
|
</div></main>
|
|
</div>
|
|
<script>
|
|
(function(){var k='balinyaar-docs-theme';var s=localStorage.getItem(k);
|
|
if(s)document.documentElement.setAttribute('data-theme',s);
|
|
else if(matchMedia('(prefers-color-scheme: dark)').matches)document.documentElement.setAttribute('data-theme','dark');})();
|
|
function __t(){var d=document.documentElement;var n=d.getAttribute('data-theme')==='dark'?'light':'dark';
|
|
d.setAttribute('data-theme',n);localStorage.setItem('balinyaar-docs-theme',n);}
|
|
</script>
|
|
|
|
</body>
|
|
</html>
|