ApexAV customer docs (staging)
This is the customer-facing documentation corpus, authored with the authoring-docs skill and staged in-repo until the docs site (docs.apexavcloud.com) is stood up. Everything here is audience: customer. Internal docs stay in docs/<category>/ per docs/README.md and never live here.
Structure (Diátaxis)
| Folder | Type | Reader is asking |
|---|---|---|
tutorials/ | Tutorial | "Teach me by doing" |
how-to/company/ | How-to | "Help me (a Company user) do X now" |
how-to/partner/ | How-to | "Help me (a Partner) do X now" |
reference/ | Reference | "Tell me the exact facts about Y" |
explanation/ | Explanation | "Help me understand why" |
learning-paths/ | Learning path | "Make me competent in a role over time" |
Rules
- Every doc carries frontmatter with
title,type,audience: customer,summary. - Author and review with the
authoring-docsskill. It enforces the five gates (type purity, audience, AI-tell scan, reader altitude, visual/multimodal). - Screenshots are captured with the kit in
docs/docs-kit/capture/. Where a live screen is not yet captured, an HTML comment<!-- capture: <shot-name>. <what it shows> -->marks the spot. Readers never see it; the capture pass replaces it with a<ThemeImage>. A diagram or table carries the information in the meantime. - Callouts use the
> [!NOTE]form with the marker on its own line. Text on the marker line becomes a plain title and its links do not render.
Provenance
Seeded by migrating and de-AI-ing the legacy static pages (marketing/docs-howto.html, docs-technical.html, docs-whitepaper.html, docs-versioning.html), then adding net-new tutorials and learning paths.