Skip to main content

draft-conceptual

Draft a new conceptual documentation page or update an existing one. Use for pages that explain what something is, why it exists, and how it works — without step-by-step procedures. Examples include product overviews, architecture explanations, and design philosophy pages.

Informações da origem

Repositório
warpdotdev/docs
Última atividade na origem
28 de agosto de 2026 às 18:38
Idioma detectado do SKILL.md
inglês
Estrelas
44
Forks
27

Opções de instalação

Por padrão, está selecionado o prompt que primeiro revisa a origem. Você pode mudar para um comando direto ou baixar uma cópia local.

Revise os arquivos de origem

Leia o SKILL.md e os arquivos complementares exibidos pelo SkillsMP antes de decidir se vai instalar.

Exibindo SKILL.md

SKILL.md
Instruções da origem · Visualização somente leitura
name
draft_conceptual
description
Draft a new conceptual documentation page or update an existing one. Use for pages that explain what something is, why it exists, and how it works — without step-by-step procedures. Examples include product overviews, architecture explanations, and design philosophy pages.
# Draft conceptual page Draft a conceptual documentation page that explains what a feature or concept is, why it matters, and how it works at a high level. ## Workflow Follow the workflow in `.agents/skills/draft_docs/SKILL.md`, using the **conceptual template** at `.agents/templates/conceptual.md`. ## Frontmatter description One to two sentences, 50-160 characters, saying what the concept is and why it matters. Start with the subject. - ✅ `Environments give cloud agents the same toolchain and setup on every run, no matter what triggers them.` - ❌ `Learn about environments and why they are useful.` See "Descriptions by content type" under Frontmatter in `AGENTS.md` for the full rules. ## Content type rules These rules are specific to conceptual pages (from the "Drafting by content type" section of `AGENTS.md`): - Explain "what" and "why" before "how" - Define new terms when they first appear - Use diagrams or architecture descriptions where they clarify relationships - **Do NOT include step-by-step procedures** — link to a procedural or quickstart page instead - Show real-world scenarios, not just abstract descriptions - Title convention: noun or "About [subject]" - Apply the tone rules in AGENTS.md → Voice & tone: no marketing buzzwords or meta-openers, and no internal architecture the reader can't act on. Run a deletion-only "Cut again" pass before presenting the draft — a short page is a finished page. ## Heading case All headings (H1–H4) must use **sentence case**: capitalize only the first word and proper feature names. - ✅ `## How it works` - ✅ `## When to use Codebase Context` - ❌ `## How It Works` - ❌ `## When To Use Codebase Context` ## Existing examples Read 2-3 of these strong examples to match the existing pattern: - `src/content/docs/platform/deployment-patterns.md` - `src/content/docs/platform/index.mdx`
Ver no GitHub