---
description: "Guidance for writing and formatting the `docs/features.md` file."
applyTo: "docs/features.md"
---

# Features Documentation Guidelines

When creating or updating the `docs/features.md` file, please adhere to the following guidelines to ensure clarity and consistency:

## Structure

    - This document should provide a short, to the point overview of each feature. It is used for marketing of the project. A quick read of what the feature is and why it matters. It is the "elevator pitch" for each feature.
    - Each feature should have its own section with a clear heading.
    - Use bullet points or numbered lists to break down complex information.
    - Include relevant links to other documentation or resources for further reading.
    - Use consistent formatting for headings, subheadings, and text styles throughout the document.
    - Avoid overly technical jargon; the document should be accessible to a broad audience. Keep novice users in mind.
    - This is not the place for deep technical details or implementation specifics. Keep those for individual feature docs.

## Content
    - Start with a brief summary of the feature.
    - Explain the purpose and benefits of the feature.
    - Keep descriptions concise and focused.
    - Ensure accuracy and up-to-date information.

## Review
    - Changes to `docs/features.md` should be reviewed by at least one other contributor before merging.
    - Review for correctness, clarity, and consistency with the guidelines in this file.
    - Confirm that each feature description reflects the current behavior and positioning of the project.
    - Ensure the tone remains high-level and marketing‑oriented, avoiding deep technical implementation details.
