# Canonica Pre-Onboarding Owner Guide

Use this guide before you run the Canonica pre-onboarding prompt in your AI coding tool.

## What You Are Preparing

You are preparing source truth for Canonica Knowledge Intake. The goal is not to make a polished marketing document. The goal is to give Canonica enough reviewed product context to create support drafts, product surface mappings, FAQ seeds, answer proposals, and live-support readiness checks.

## Minimum Inputs

At minimum, give the agent:

- product name;
- public website URL, docs URL, local repo/docs path, or owner-written product notes;
- product stage: public live, private beta, pre-launch, or docs-only;
- source mode: repo and website, multi-product repo, website only, docs only, owner notes only, or mixed;
- support contact or escalation path;
- approval status for legal, pricing, privacy, security, screenshots, and marketing use.

## Fields You Will Fill In The Prompt

- `PRODUCT_NAME`: paste the product name.
- `PRODUCT_SLUG`: paste a short lowercase slug for the output folder.
- `PUBLIC_WEBSITE_URL`: paste the website link or `NOT_AVAILABLE`.
- `PRODUCTION_APP_URL`: paste the app/login link or `NOT_AVAILABLE`.
- `REPO_OR_DOCS_PATH`: paste the local repo/docs path or `NOT_AVAILABLE`.
- `TARGET_PRODUCT_PATHS`: paste target app/package/docs paths when a repo contains multiple products, or `NOT_AVAILABLE`.
- `EXCLUDED_PRODUCT_NAMES`: paste sister products that must stay out, or `NOT_AVAILABLE`.
- `HELP_DOCS_URLS`: paste docs/help links or `NOT_AVAILABLE`.
- `OPENAPI_OR_API_SPEC_PATHS`: paste public API spec paths/URLs or `NOT_AVAILABLE`.
- `SUPPORT_EXPORT_PATHS`: paste support macro, FAQ, solved-ticket, or CSV/Markdown export paths or `NOT_AVAILABLE`.
- `DEMO_RECORDING_OR_SCREENSHOT_PATHS`: paste approved demo recording/screenshot paths or `NOT_AVAILABLE`.
- `WEBSITE_ASSET_REQUEST`: choose `none`, `faq`, `website_copy_brief`, `demo_walkthrough`, `screenshots`, or `mixed`.
- `PRICING_URL`, `PRIVACY_URL`, `TERMS_URL`, `REFUND_OR_CANCELLATION_URL`, `SECURITY_TRUST_URL`, `CONTACT_URL`: paste links or `NOT_AVAILABLE`.
- `SUPPORT_EMAIL`: paste the support email or `NOT_AVAILABLE`.
- `SOURCE_MODE`: choose `repo_and_website`, `multi_product_repo`, `website_only`, `docs_only`, `owner_notes_only`, or `mixed`.
- `PRODUCT_STAGE`: choose `public_live`, `private_beta`, `pre_launch`, or `docs_only`.
- `APPROVAL_STATUS`, `SCREENSHOT_MARKETING_PERMISSION`, `CANONICA_WORKSPACE_STATUS`: paste the current approval/workspace status.
- `OWNER_NOTES`: paste a short product summary or `NOT_AVAILABLE`.

## Best Setup

Use the strongest source bundle you have. A product repo is helpful, but it is not required. The agent can work from any combination of:

- product repo files when available;
- docs and help content;
- public website source or live URLs;
- route definitions or page files;
- pricing, terms, privacy, security, and contact pages;
- OpenAPI/API specs for public APIs;
- support exports, macros, solved-ticket patterns, or FAQ files;
- approved recordings for product walkthroughs;
- existing support macros, FAQs, changelogs, and onboarding notes;
- approved screenshots or demo data notes.

## If You Have A Product Repo

1. Open the repo in your AI IDE.
2. Make sure current docs are present locally.
3. Paste the master prompt.
4. Fill in the product name, website, app URL, docs URLs, and approval status.
5. Let the agent inspect the repo and public website.
6. Ask it to patch any gaps before final handoff.
7. Review the generated folder before upload.

## If The Repo Has Multiple Products

Tell the agent which product Canonica is onboarding. Fill `TARGET_PRODUCT_PATHS` when you know them and `EXCLUDED_PRODUCT_NAMES` for sister products that must stay out. The agent should map the codebase first, include shared infrastructure only when it affects the target product, and document exclusions before upload.

## If You Do Not Have A Product Repo

You can still use pre-onboarding. Give the agent:

- public website URLs;
- help center URLs;
- pricing/legal/security/contact URLs;
- product screenshots;
- support macros or FAQ exports;
- a written list of product pages, roles, plans, integrations, and risky topics.

The agent should mark repo-code coverage as unavailable and continue from public/docs/owner-provided sources.

## If You Only Have Owner Notes

You can still create a starter package. Give the agent a short product summary, role list, key workflows, support email, screenshots if approved, and any known policies. The agent should mark website, repo, docs, and production checks as pending instead of filling gaps with guesses.

## If You Want FAQ, Demo, Or Website Assets

Fill `WEBSITE_ASSET_REQUEST` and provide approved recordings, screenshots, support exports, or API specs when available. The agent should prepare source-backed FAQ seeds, demo walkthrough briefs, website claim candidates, capture plans, and scrub rules. Treat these as review-ready briefs, not approved public assets.

## What This Cannot Guarantee

This process depends on what the AI tool can actually inspect. Some AI IDEs cannot browse the web, read private repos, open login-only apps, inspect recordings, or access local files without extra permission. If a source is blocked or missing, the generated package should mark that source as pending instead of claiming coverage.

No prompt can guarantee perfect output for every product, model, IDE, private app, or source shape. Owner review is mandatory before uploading the package to Canonica or using the material for support, website, FAQ, demo, or screenshot assets.

## What To Review Before Upload

Check the generated folder for:

- private customer data;
- API keys, tokens, cookies, secrets, or service accounts;
- payment details, invoices, or raw logs;
- private support conversations;
- screenshots with personal or customer information;
- legal, refund, privacy, or security statements that need approval;
- product claims that are not true in production.

Remove or correct anything questionable before uploading to Canonica.

## What To Upload First

Start with the numbered files in `source-inputs/`. Upload in numeric order when possible. Then use the production onboarding files for product surfaces, live-support tests, screenshot planning, and activation review.

## When To Enable Live Support

Do not enable Canonica for live users until:

- source files are uploaded;
- drafts are reviewed;
- risky topics are escalation-gated;
- product surfaces are mapped;
- widget context is verified;
- common support test questions pass;
- production-only facts are confirmed.

## What Production Facts Still Need Confirmation

- Active production host and app URL.
- Active feature flags.
- Plan/account entitlements.
- Current pricing, refund, privacy, and legal text.
- Widget key and allowed origins.
- Approved screenshot/demo tenant.
- Public marketing permission.

## Good Final Output

A good agent final response should tell you:

- folder path;
- source count;
- payload count;
- FAQ and test question counts;
- product surface count;
- screenshot register count;
- largest source size;
- website/docs checked;
- source-access limits or blocked sources;
- products detected and target product boundary if a multi-product repo was inspected;
- sister products or source families excluded;
- gaps found and fixed;
- production confirmations still needed.
