@custyle/kb
v0.1.0
Published
Custyle customer-facing knowledge base (powers Converse Domain)
Readme
Custyle Knowledge Base
The customer-facing knowledge base for Custyle.ai — the world's first AI Merch Agent.
This repository is the single source of truth that powers the Custyle Converse Domain (AI customer service / self-serve). Every entry here is consumed by an LLM at runtime to answer user questions about the platform.
What lives here
| Path | Purpose |
|------|---------|
| KB.md | Master index — start here |
| topics/ | Knowledge entries organized by user intent |
| schema/ | Frontmatter schema, intent catalog, writing style guide |
| boundaries/ | What the KB must NOT answer — directly maps to Converse safety flags |
| handoffs/ | When and how to route to APIs, design flow, or humans |
| glossary/ | Canonical terms — keeps voice consistent |
| eval/ | Golden Q&A + boundary tests for regression |
| scripts/ | validate / lint / export-for-rag |
What does NOT live here
- Live commerce facts (price, inventory, order status, shipping ETA) — those come from Custyle APIs at runtime, not from this repo. See
boundaries/do-not-answer.md. - Investor / financial / market materials — see
custyle-brand/market/. - Internal engineering architecture — see
custyle-platform/docs/. - Brand engine source of truth — see
custyle-brand/(this KB consumes it).
Design principles
- Atomic — one file = one user intent answered.
- Quotable — every entry has a
Quick answer≤ 80 words that the Answer LLM may surface verbatim. - Bounded — every entry declares
boundaryflags that map 1:1 to Converse Domain safety constraints. - Sourced — every fact is traceable to brand engine, code, or a public help page.
- Versioned — every entry has
last_verifiedandreview_cadence_days; stale entries auto-degrade confidence in CI. - Tested —
eval/golden-questions.yamlprotects against regression.
Status
Phase 1 — Content complete. 64 entries across 9 categories, all at confidence: medium. Pipeline clean (validate 0/0, lint 0/0). Every entry carries an Editorial notes section flagging extrapolations for owner verification.
See KB.md for the per-category status board and NEXT.md for the medium → high promotion plan.
Runtime Export
custyle-platform consumes the generated runtime index, not the markdown files directly.
pnpm install
pnpm buildpnpm build runs:
pnpm validate— validate topic frontmatter and relationships.pnpm lint— enforce public-content guardrails.pnpm export— generatekb-index.json.pnpm validate:export— verify the runtime export contract.
The generated kb-index.json includes runtime metadata such as language, confidence, last_verified, and review_cadence_days. It excludes confidence: low stubs and writer-only sections such as Sources and Editorial notes.
Contributing
See CONTRIBUTING.md.
License
Proprietary. © Custyle 2026.
