OptoLink internal docs
OptoLink is a deep linking and mobile attribution platform: short links route mobile
users to in-app content, deferred deep linking preserves intent across the install
flow, and click events are tracked for analytics and billing. This is the
project-wide, repo-private documentation. It is built by npm run build for local
reading only — npm run build:public (the deploy artifact) excludes /internal
entirely.
The repos
| Repo | What it is |
|---|---|
optolink-backend | NestJS API — the platform backend |
optolink-portal | React SPA — the customer dashboard |
optolink-flutter | Flutter SDK |
optolink-node | Node/TypeScript SDK (npm: @optomatica/optolink-sdk) |
optolink-android | Android SDK (Maven Central) |
optolink-ios | iOS SDK |
optolinkWeb | Public landing page |
optolink-docs | This site — public /docs + internal /internal |
Per-repo mechanics (run, test, structure, release) live in each repo's docs/
folder, not here. Clone repos as siblings; expect ../optolink-docs/ next to the
code. If it's missing:
git clone [email protected]:Optomatica/optolink-docs.git as a sibling.
How this is organized
| Where | What |
|---|---|
| decisions.md | Platform decisions — identity-level choices binding every repo |
| backlog.md | Live task/effort tracker — read before starting, update when starting/finishing |
| governance.md | How these docs themselves work: allocation rules, templates, new-repo checklist |
product/ | PRD, pricing, feature registry, design system |
research/ | Competitor + platform research snapshots — written once, not maintained |
systems/<domain>/ | Self-contained per subsystem: how it works + domain-specific verification |
testing/ | The shared test rig: what you test against, who you test as, how to run a session |
operations/ | Shipping & configuration across repos: release policy, env-var registry |
archive/ | history.md (what changed and when) + frozen records |
Boundary rules: domain-specific test procedures live in systems/<domain>/;
the shared rig (infrastructure, accounts, cross-repo procedures) lives in
testing/. Repo mechanics live in the repo; if a sentence would still be true if
the repo were rewritten in another framework, it belongs here.
Page contract
Every page carries frontmatter (title, description, sidebar_position,
status, source), a one-line scope statement, and a maintenance comment ({/* */} on these MDX pages,
HTML comments in plain-markdown repos). Claims about code carry a verification line
(> Verified against <repo> @ <sha>, <date>). See governance;
templates in templates/ at the docs-repo root.
Verified against the sibling workspaces and optolink-docs @ 528fa4e, 2026-10-07 (B-010): all eight repos present with the roles above; the section map matches
internal/one-to-one; build split perdocusaurus.config.ts.