mirror of
https://gitee.com/nocobase/nocobase.git
synced 2025-05-09 07:29:24 +08:00
24 lines
722 B
Plaintext
24 lines
722 B
Plaintext
---
|
|
description:
|
|
globs:
|
|
alwaysApply: true
|
|
---
|
|
---
|
|
description: Guidelines for writing and maintaining project documentation using Dumi.
|
|
globs: "docs/**/*.md"
|
|
---
|
|
|
|
# Documentation Guidelines
|
|
|
|
- **Structure**:
|
|
- Organize documentation files within the `docs` directory.
|
|
- Use a clear and consistent hierarchy to facilitate navigation.
|
|
|
|
- **Content**:
|
|
- Provide comprehensive explanations and examples for components and features.
|
|
- Keep language clear and concise, suitable for both new and experienced developers.
|
|
|
|
- **Dumi Integration**:
|
|
- Utilize Dumi's features to create interactive and visually appealing documentation.
|
|
- Ensure that documentation is updated alongside code changes to maintain accuracy.
|