You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: Guidelines for writing and formatting documentation for public library interfaces in packages
4
3
alwaysApply: false
5
4
---
5
+
# Package Documentation Writing Guidelines
6
6
7
-
# Package Documentation Requirements
8
-
9
-
When making changes to public library interfaces in `/packages`, you **must** update the corresponding documentation in `/docs`.
7
+
This guide covers how to write and format documentation for public library interfaces. For information on **when** documentation updates are required, see `.cursorrules`.
10
8
11
9
## Documentation Structure
12
10
@@ -21,37 +19,6 @@ Each package documentation has subdirectories:
21
19
- `concepts/` - Conceptual documentation
22
20
- `getting-started/` - Getting started guides
23
21
24
-
## When to Update Documentation
25
-
26
-
### Breaking Changes
27
-
28
-
**Breaking changes** include:
29
-
- Removing public APIs (classes, functions, methods, hooks, composables)
0 commit comments