globs: docs/**
---
# Diátaxis Documentation Guidelines
When writing or editing documentation, categorise each page as **one** of the four Diátaxis modes and follow its specific guidance. *Do not mix modes
1 project uses a version of this
16k13mo agoReviewMountCreate a free account to mount
globs: docs/**
---
# Documentation Structure & Workflow
Follow these conventions when creating or editing documentation:
1. **Docs live in [docs/](mdc:docs/)**
• Use Markdown (`.md`) files.
• Images and other assets
1 project uses a version of this
16k13mo agoReviewMountCreate a free account to mount
extra
• Local development: `uv pip install -e . -e ./examples`
• Usage: `python -m ragas_examples.benchmark_llm.prompt`
Shared documentation for all projects is located under [docs/](docs/).
Root-level [Makefile](Makefile) provides combined commands
1 project uses a version of this
16k13mo agoReviewMountCreate a free account to mount
description:
globs:
alwaysApply: true
---
# Coding Guidelines
This document outlines the coding standards and best practices for contributing to Albumentations.
## Important Note About Guidelines
These guidelines represent our current best practices
15k17mo agoReviewMountCreate a free account to mount
behavior
## Available Rules
Currently, the following rules are defined:
### `simple-language.mdc`
- **Purpose**: Ensures documentation is written at a grade 10 reading level
- **Applies to**: Markdown files (*.md)
- **Auto Apply
Steady12 mentions in 2 weeks
No other project uses it yet
14k6mo agoReviewMountCreate a free account to mount
integrated into the `frontend/` directory of this backend repository via a git submodule.
- Documentation Repository: The official documentation site is hosted in the `open-llm-vtuber.github.io` repository. When asked to generate documentation
Steady5 mentions in 2 weeks
No other project uses it yet
14k15mo agoReviewMountCreate a free account to mount
implementation
4. Maintain the "Relevant Files" section with accurate file paths and descriptions
5. Document implementation details, especially for complex features
6. When implementing tasks one by one, first check
Steady10 mentions in 2 weeks
1 project uses a version of this
13k8mo agoReviewMountCreate a free account to mount
switch clauses.
- Don't use variables that haven't been declared in the document.
- Don't write unreachable code.
- Make sure super() is called exactly once on every code path
Steady10 mentions in 2 weeks
No other project uses it yet
13k8mo agoReviewMountCreate a free account to mount
Follow consistent coding standards and formatting rules across the project to enhance clarity.
## 5. Documentation and Comments
- **English Language:**
All code comments and documentation should be written in English
No other project uses it yet
12k44d agoReviewMountCreate a free account to mount