1.7 KiB
1.7 KiB
Support Topics
Support topics are small, candidate-scoped investigation guardrails injected into sub-agent briefs.
They are not recommendations, gates, scanners, or broad documentation. A topic tells the investigator what evidence to check, what false positives to avoid, and when to abstain for one class of candidate.
Add A Topic
Add one file: references/support-topics/<id>.md.
The filename must match the id. Frontmatter uses a strict subset of YAML: one key: value per line, arrays as JSON arrays.
---
id: cdn-cache-auth-safety
title: CDN cache auth safety
status: active
candidateKinds: ["uncached_route", "cache_header_gap"]
frameworks: ["*"]
priority: 90
citations: ["https://vercel.com/docs/caching/cdn-cache"]
maxBriefChars: 900
---
## Investigation Brief
...
## Evidence To Check
...
## Do Not Recommend When
...
## Verification
...
Rules
- Every active topic must cite only URLs or skill-rule refs already present in
references/docs-library.json. - Use
candidateKindsto keep the topic narrow. Use"*"only for workflow/protocol topics that truly apply to every candidate. - Use optional
metricsonly when a topic applies to a specific candidate metric, such as["LCP"],["INP"], or["CLS"]for Core Web Vitals. - Use optional
routePatternsas JavaScript regex source strings when a topic should appear only for specific candidate routes, such as["(^|/)404$"]. - Keep the body below
maxBriefChars; the brief renderer caps selected topics before they reach the sub-agent. - Put URLs in frontmatter only. Topic bodies should describe checks and guardrails, not cite new sources.
- Do not include internal repository paths, service names, pricing tables, exact savings claims, or framework APIs without version gating.