Skip to content

Commit 14a4b02

Browse files
balzssclaude
andcommitted
docs: clarify Claude Code documentation guidelines
Improve CLAUDE.md with: - Clarify that component READMEs render instructure.design docs - Simplify component development workflow steps - Add gray-matter reference for documentation syntax - Refine wording for better clarity 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent 7523dd4 commit 14a4b02

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

CLAUDE.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -81,23 +81,24 @@ npm run clean-node && npm install # Nuclear option (removes all node_modu
8181
**Each component has two READMEs:**
8282

8383
1. **Component README**: `/packages/[package]/src/[Component]/README.md`
84-
- Usage examples and guidelines
84+
- What the component does and usage examples
8585
- **Check this first** - it has the detailed information
86+
- These READMEs are also used to render the component documentation pages on instructure.design
8687

8788
2. **Package README**: `/packages/[package]/README.md`
8889
- Package overview, installation, exports
8990

90-
**For complete API details:**
91+
**For complete API details of a component:**
9192
- Props: Check `props.ts` files in component source
9293
- Theme variables: Check `theme.ts` files in component source
9394

9495
## Component Development Workflow
9596

9697
1. Find component in `/packages/ui-[name]/src/[Component]/`
9798
2. Check Component README for API details
98-
3. Make changes (functional components only)
99+
3. Make changes
99100
4. Run tests: `npm run test:vitest`
100-
5. Update both README files if needed
101+
5. Update README if the functionality has changed (e.g., a new prop was added)
101102
6. Use `/commit` to create commit
102103

103104
## Breaking Changes
@@ -154,7 +155,7 @@ See `/regression-test/README.md` for detailed instructions.
154155

155156
## Writing Documentation
156157

157-
InstUI uses custom markdown with special code blocks for interactive examples.
158+
InstUI uses custom markdown with special code blocks (using [gray-matter](https://github.com/jonschlinkert/gray-matter) YAML syntax) for interactive examples.
158159

159160
**Code block types:**
160161
- `type: code` - Syntax highlighting only

0 commit comments

Comments
 (0)