Skip to main content

draft-reference

Draft a new reference documentation page or update an existing one. Use for structured factual information meant for lookup — CLI commands, API endpoints, configuration options, keyboard shortcuts, error codes. Reference pages describe and only describe.

소스 정보

저장소
warpdotdev/docs
최근 소스 활동
2026년 10월 6일 05:43
감지된 SKILL.md 언어
영어
스타
44
포크
27

설치 방법

기본적으로 소스를 먼저 확인하는 Prompt가 선택됩니다. 직접 명령으로 전환하거나 로컬 사본을 다운로드할 수도 있습니다.

소스 파일 검토

설치 여부를 결정하기 전에 SKILL.md와 SkillsMP에 표시된 보조 파일을 읽어 보세요.

SKILL.md 표시 중

SKILL.md
소스 지침 · 읽기 전용 미리보기
name
draft_reference
description
Draft a new reference documentation page or update an existing one. Use for structured factual information meant for lookup — CLI commands, API endpoints, configuration options, keyboard shortcuts, error codes. Reference pages describe and only describe.
# Draft reference page Draft a reference documentation page with structured, exhaustive information for developer lookup. ## Workflow Follow the workflow in `.agents/skills/draft_docs/SKILL.md`, using the **reference template** at `.agents/templates/reference.md`. ## Frontmatter description One to two sentences, 50-160 characters, saying what the reader can look up. Name the artifacts, not the genre. - ✅ `Look up Warp Agent CLI flags, environment variables, slash commands, and keyboard shortcuts.` - ❌ `Reference documentation for the Warp Agent CLI.` See "Descriptions by content type" under Frontmatter in `AGENTS.md` for the full rules. ## Content type rules These rules are specific to reference pages (from the "Drafting by content type" section of `AGENTS.md`): - Be exhaustive — document every option, flag, and configuration value. - Use consistent formatting for parameters (e.g., `--flag` in backticks, description as a dash-separated list item). - Alphabetize entries where ordering doesn't matter. - Keep descriptions factual and concise — this is for lookup, not learning. - Include at least one practical example for each command or endpoint. - **Adopt standard patterns ruthlessly** — consistency is more important than style. Every entry must follow the same structure. - Structure should mirror the structure of the product it describes. - Use H2 for sections, H3 for subsections. Tables for multiple elements, lists for single. - Title convention: noun describing contents ("Keyboard shortcuts", "CLI commands") ## Heading case All headings (H1–H4) must use **sentence case**: capitalize only the first word and proper feature names. - ✅ `# CLI commands` - ✅ `## Running agents` - ❌ `# CLI Commands` - ❌ `## Running Agents` ## Existing examples Read 2-3 of these strong examples to match the existing pattern: - `agents/cli/oz-cli/index.mdx` - `factories/api-and-sdk/index.mdx`
GitHub에서 보기