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.

Informations de source

Dépôt
warpdotdev/docs
Dernière activité de la source
28 août 2026 à 18:38
Langue détectée de SKILL.md
anglais
Étoiles
44
Forks
27

Options d'installation

Le prompt qui vérifie d'abord la source est sélectionné par défaut. Vous pouvez passer à une commande directe ou télécharger une copie locale.

Vérifiez les fichiers source

Lisez SKILL.md et les fichiers associés affichés par SkillsMP avant de décider de l'installer.

Affichage de SKILL.md

SKILL.md
Instructions source · Aperçu en lecture seule
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`
Voir sur GitHub