Contributing to kdeps docs

This page tells you how to add or change a page under docs/v2/. Read the style guide first.

1. Pick one content type

A page is exactly one type. If your page answers two questions, split it.

You want to...	Use type	Skeleton below
Explain an idea or how a subsystem works	Concept	Concept
Teach a beginner by building one example end to end	Tutorial	Tutorial
Give exact steps for one task the reader already understands	How-to	How-to
List fields, flags, functions, or values	Reference	Reference
Get a new user to a working result fast	Quickstart	Quickstart
Help a user fix a specific failure	Troubleshooting	Troubleshooting

2. Use the matching skeleton

Concept skeleton

# <Noun phrase>

<One sentence: "X does Y" or "X is like Z, but W". State the mode(s).>

<Definition paragraph. What it is, what problem it solves.>

<D2 or ASCII diagram if the concept has 4+ parts or branching.>

## Background   <!-- optional -->
## Use cases
## Comparison of <alternatives>   <!-- optional -->
## See also

Tutorial skeleton

# <Verb phrase: "Build a ...">

## Overview
<What you will build, who it is for, assumed knowledge, learning objectives.>

## Before you start
<Prerequisites as a bullet list.>

## <Task 1>
1. <Verb-first step.>

## Summary
## Next steps

How-to skeleton

# <Verb phrase: "Deploy kdeps to ...">

## Overview
<One or two sentences: what this achieves and when to do it.>

## Before you start   <!-- optional -->
## <Task>
1. <Verb-first step.>

## See also

Reference skeleton

# <Thing> reference

<Scope: what this covers and how it relates to other pages. State the mode(s).>

## <Group>
| Field | Description | Example |
| :--- | :--- | :--- |

## Commands   <!-- optional -->
| Command | Description | Argument | Example |
| :--- | :--- | :--- | :--- |

## Examples
## See also

Resource pages (resources/*) are reference pages. Use: Overview -> Fields table -> Examples -> See also.

Quickstart skeleton

# <Product> quickstart

## Overview
<The parts this covers, the audience, assumed concepts.>

## Before you start
## Install
## Part 1: <task>
### Step 1: <step>

## Next steps

Troubleshooting skeleton

# Troubleshooting <area>

<Scope in one or two sentences.>

## Symptom: <what the user sees>
### Cause
### Solution
### For more information

3. Validate

cd docs/v2
npm run build     # VitePress build - catches dead links and broken D2 blocks

Update README.md and book/ in the same change when a page changes behavior, schema, or a CLI flag.