Documentation map¶
Which content is public, partner, client-specific, or internal — and where it lives.
Classification is based on what a page discloses, not whether its title says “internal.” Machine-readable list: on the internal site, see Access → Page classification.
Classes¶
| Class | Meaning | Typical readers |
|---|---|---|
| Public | Safe product capability, readiness, and orientation | Anyone with the public docs URL |
| Partner | Integrator contracts: headers, schemas, external behaviour | Client and partner engineers |
| Client-specific | Named customer packs, tenant-specific routes, private payloads | Restricted — not on the public site |
| Internal | Engineering, ops, ADRs, findings, env secret names, attack-surface detail | MasteryHive staff (Access-controlled site) |
Public site sections¶
| Section | Class | Contents |
|---|---|---|
| Getting Started | Public | Landing, overview, journeys, glossary, environments, access onboarding, style guide, status vocabulary, this map |
| Products | Public | Stakeholder product pages, readiness summary, TM lifecycle, recon guides |
| Integration | Partner | Lifecycle, conventions, auth tutorial, quickstarts, examples, OpenAPI, collection, changelog |
| API Reference | Partner | Named contracts, generated endpoint maps, partner OpenAPI embeds |
| Support | Partner | Triage, error matrix, missing-report, known limitations (no internal vulns) |
| Architecture | Public | Overview + system map only |
Internal-only sections¶
| Section | Why internal |
|---|---|
| Engineering | Repo layout, topics, deploy flags, code trails, trust/deps/deploy maps, onboarding |
| Troubleshooting | Env vars, topic names, finding IDs, credential diagnostics, DLQ/stuck-session |
| Operations & Limitations | Deploy/rollback, observability, SLO proposals, incident, policy packets, gaps |
| Decisions | ADR index + ADRs |
| Access (meta) | Access-control proposal, full classification YAML |
Client-specific¶
There are no dedicated client pack pages on this docs tree today. Client names, tenant UUIDs, and client-only routes are blocked from the public build by automated scans. If you need a private pack, request it through MasteryHive account channels — it will not be published on the public Cloudflare site.
Build and publish rules¶
- Public deploy uses an explicit allowlist (
public-allowlist.txt) plus scanners. - Internal HTML must not be uploaded to the public Pages project.
- Cloudflare Access topology for the internal site is documented on the internal Access pages (not published here).