augment-it/specs
- Path
- specs/index.md
Specs
- API-First In-App Documentation — Each Surface Reveals Its Own Docs Inline - Every remote and service ships its own docs inline — an icon-CTA reveals the data flowing in, the calls fired, the response shapes.
- Augment from Affiliations — the first flow that starts from SurrealDB instead of a CSV, turning an event’s speaker/org pairs into a rated, sourced prospect list - The first flow that starts in the canonical layer, not a CSV: export an event’s affiliations, rate relevance offline, reimport.
- Augment from DB — the Org Workbench + Search-and-Add flow: two new microfrontends over capabilities that mostly exist - Start from a canonical org, not a CSV row: an org workbench over links, streams, corpus and people, plus provider-pluggable search-and-add.
- Augment-It as a CRM-Augmentation Pipeline (Microfrontends + Microservices) - memopop makes memos, dididecks makes slides, augment-it makes information that lands back in a CRM it doesn’t own.
- Chat Context-Awareness Architecture — three layers (workspace as context broker, slab-assembly contract, verb registry) that grow the in-app chat from prompt-only to surface-aware verb router - Chat’s verb roster is a hand-written prose block and its context slab carries only
record_set_id; this closes both holes. - Client tagging on canonical writes — every observation carries the client that produced it, and every canonical entity carries the materialized set of clients that can see it - The canonical layer is cross-client by design — a materialized
client_accessarray is how each workspace still sees only its own. - The component API contract and the control scale — inspired by shadcn, with sprinkles of Tailwind, derived from what members already built - Members were already converging on Tailwind’s radius scale by instinct. They just had no token to spell it with.
- Connector Inventory & Per-Record Palette — Hot-Swap Providers, Re-Fire One Record at a Time - Per-record connector palette: click
fto re-fire one row through the next Facebook provider, over a registry that resolves by capability. - Corpora Builder Harmony — the evolving test registry - Every proposed and implemented test guarding the corpora builder and the systems it must harmonize with — identity, workspace connector, transport, state, canonical layer, files — in human language, MECE, one ✓-phrase each.
- Strategy Curator — An Entry-Point App for augment-it - A canonical source registry in SurrealDB owns identity, the client’s filesystem owns usage, and a shared UUID is the only bond.
- Corpus Inbox — capture first, triage later; a zero-friction save destination for URLs without a home yet, with a future triage layer that sorts inbox content into the right places - A URL with no home yet shouldn’t cost a filing decision:
corpus/inbox/captures the page, its body, and a drive-by note, then waits. - Design System Convergence — the organ registry, its five verdicts, and the fingerprint ledger that catches drift while it happens - The registry is what makes drift legible: a declared organ is a decision, an undeclared one is drift. The code can be identical in both cases.
- Design System Portal - Specification for the portal that renders the federated design system — the swatch page, the token catalogue, the member index.
- Enhanced Records List — the Triage Checkpoint and the Promotion Loop - One record-grained view of a whole enrichment round: select the good rows, promote them to canonical, and the predecessors archive.
- Entity-Card Edit & Remove Affordances — every visible property gets a micro-button pair - The org card views and edits in place, but only additively — a misclicked ➕ today required a direct database write to undo. Every entry and identity property the card shows grows ✎ and × micro-buttons.
- Entity-Pulse Bundle — Press Releases, News Mentions, and the Social Voice of a Record - Official Updates fires first; its rollup becomes the relevance prior for Media and Socials Mentions — a foundation-first four-phase DAG.
- Federated Component Libraries - One gallery runtime, seventeen sovereign catalogs — every member publishes what it is made of, at its own address.
- Federated Design System Architecture - The organising specification for augment-it’s two-tier, seventeen-member design system.
- Flow for Bundles & Packs — The Simplest Possible Thing - For 67 rows with a website URL, find each one’s blog index. Two surfaces, no reviewers — this spec deliberately ignores the five before it.
- Funder Content Corpus Workflow — what the system has to do, ranked by quality bar, with no implementation prescribed - Written so a future agent resists the pull to filter yesterday’s bad data tighter instead of firing fresh for today’s good data.
- Initial User Experience — From Landing to a Productive First Action - What the first thirty seconds of augment-it feel like: a productive first action without a lecture, skippable and never re-shown.
- Per-Record Iteration as the Primary Surface for Pack and Bundle Fires — The Flow Rearranges Per Fire Type - A pack fired across 96 rows returned 0 found — so per-record iteration becomes primary and bulk fan-out waits until a chain is proven.
- Pulse Curation Layer & UI — Three Layers per Category, Triage Per Item, Finalize on Demand - Three layers per category: immutable
raw_output, livecurated_output, and afinalized_outputsnapshot locked when triage is done. - Pulse pattern — one operator burst against one entity, expressed as N independent pulse-dimensions composed in a pulse-surface, each dimension potentially owning its own microservice - Operators enrich in bursts, not steps: one search fills name, socials, emails, and org, and a pulse-surface commits all of it in one save.
- Record ↔ DB Resolver — operator-driven match/create bridge from row-store records to canonical organizations - Row-store records and canonical SurrealDB orgs were never bridged; the resolver closes the gap one record at a time, operator driving.
- Record-Set Family Grouping — internal lineage vs. external-variant families in the Record Collector sidebar - The sidebar shows a tracker uploaded as v4–v8 as five unrelated CSVs. Two family kinds — promotion lineage and external variant — fix that.
- Records Surface sort step and UI — sort ships as part of the Sort & Filter Lens, the second lens in step 2’s default set (alongside the existing Pack Firing Lens);
lensis the architectural primitive this spec introduces and lenses are swappable (one active per step at a time), not stackable; each step ships with a small curated default lens set and the registry stays open so new lenses can join without architecture changes - Sort ships as the second swappable lens on step 2 — and the lens registry is open, so a new lens is a manifest drop, not an enum edit. - Request Reviewer — the Pre-Flight Surface - See exactly what is about to leave the building — and guarantee the request you reviewed is byte-identical to the one that fires.
- Response Reviewer Shell and Content-Reader Mode — Response Reviewer becomes a wrapper whose inner review UI swaps based on what the bundle that fired actually produced - 1,109 OfficialPulse responses, 3 accepts: ‘is this URL right?’ is the wrong question for content packs, so review mode becomes swappable.
- Response Reviewer and Response Store — the Post-Flight Surface - No review surface until a fired response is a first-class stored object — so response-store and response-reviewer are specced as one.
- Search-Results Queue — a right-rail microfrontend where concurrent agent searches land, signal, and get triaged - Agent searches run minutes; the operator shouldn’t. Every search becomes a card in a persistent right rail — fire many, triage on arrival.
- SearchBox — LiveFilter and Autocomplete - A subsidiary spec. Two named variants over one private core, because the keyboard contract must exist exactly once and the two differ only in where options come from.
- Shell & Micro-Frontend UX Coherence — Affordances That Are Found, Consistent, and Talk Back - A demo-prep chain of ‘I can’t find / reach / trigger X’ is a verdict: the shell’s affordances hide, die, or mismatch. Fix the pattern.
- Source Content Storage — SurrealDB-Primary, Local as a Per-User Toggle - Flip the content store: the article body moves onto the canonical
sourcesrow and the local filesystem write demotes to a toggle. - Sparse-Person Enrichment Surface — per-email triage where the operator finds the human behind the address, picks or creates the org they belong to, and writes both back to the canonical layer - 177 event attendees landed as 177 bare emails — the opposite shape from the URL-bearing records every other augment-it flow assumes.
- Tooltip System — A Versatile First-Class Family, Plus a Walkthrough for New and Returning Users - Apps fail at orientation, not functionality — so tooltips become a first-class family, not the browser’s half-working
title=. - Walking-Skeleton Pre-Flight Decisions — Augment-It Rewrite - Five substrate decisions — state, transport, persistence, auth, agent scaffolding — settled before code so no session re-walks the tree.
- Workspaces as Tenant Primitive — toggling, tenant-aware microservices, per-tenant env-var pickup, and the seam that lets MCPs and connectors vary per client -
workspaceis the tenant boundary — humain-vc vs reach-edu. The vision is stated once, then step 1 is cut down to filesystem-only bones.