Cursor rule

1# Documentation Standards with Docusaurus
2 
3## Documentation Structure
4- `docs/docs/` - Main documentation pages
5- `docs/docusaurus.config.ts` - Site configuration
6- `docs/sidebars.ts` - Navigation structure
7- `docs/static/` - Static assets (images, downloads)
8- `docs/src/` - Custom components and styling
9 
10## Standard Documentation Pages
11- `intro.md` - Introduction and mod overview
12- `installation.md` - Installation guide for players and servers
13- `usage.md` - How to use the mod features
14- `configuration.md` - Configuration options (if applicable)
15- `faq.md` - Frequently asked questions
16- `technical.md` - Technical details for developers
17- `changelog.md` - Version history and changes
18 
19## Content Standards
20- **Writing Style**:
21  - Use clear, concise language
22  - Write for both new and experienced players
23  - Avoid technical jargon where possible
24- **Formatting**:
25  - Use proper Markdown headings (##, ###)
26  - Include code blocks with syntax highlighting
27  - Add images for complex concepts
28- **Media**:
29  - Store images in `docs/static/img/`
30  - Use descriptive filenames
31  - Optimize images for web (PNG/JPG)
32  - Reference with `/img/filename.png`
33 
34## Compostables-Specific Documentation Rules
35 
36### General Principles
37- Maintain consistency across all documentation files
38- Use proper Minecraft item names (official wiki names)
39- Bold all mod items to distinguish from vanilla items
40- Keep item counts accurate (107 total mod items)
41 
42### Table Formatting
43- Follow the exact 5-column format: 30%, 50%, 65%, 85%, 100%
44- Use proper markdown table syntax
45- Include image sprites and wiki links for all items
46- Format: `[![](image-url)](wiki-link "Title")[Item Name](wiki-link "Title")`
47 
48### Item Name Standards
49- "Block of Bamboo" (not "Bamboo Block")
50- Use proper capitalization
51- Follow official Minecraft wiki naming
52- Be consistent across all files
53 
54### Files to Update Together
55When making item changes, update:
561. `docs/docs/intro.md` - Main documentation
572. `docs/docs/modrinth.md` - Modrinth description  
583. `README.md` - If item counts change
594. Any reference tables
60 
61### Image Links
62- Use minecraft.wiki image sprites
63- Format: `https://minecraft.wiki/images/[Type]Sprite_[item-name].png?[hash]`
64- Types: ItemSprite, BlockSprite, Invicon
65- Always include alt text and titles
66 
67### Wiki Links
68- Link to official Minecraft wiki pages
69- Format: `https://minecraft.wiki/w/[Item_Name]`
70- Use proper page names (spaces become underscores)
71- Include title attributes for accessibility
72 
73### Markdown Best Practices
74- Use proper heading hierarchy
75- Include emoji icons for sections (🌱, ✨, 📦, etc.)
76- Use code blocks for commands and file paths
77- Keep line lengths reasonable for readability
78 
79## Site Configuration
80- Homepage redirects to documentation
81- Navbar includes logo and navigation
82- Search functionality enabled
83- GitHub Pages deployment configured
84- Custom styling in `docs/src/css/custom.css`
85 
86## Key Features
87- **Local Search**: Client-side search functionality
88- **Responsive Design**: Mobile and desktop optimized
89- **Theme Support**: Dark/light mode switching
90- **Version Control**: Edit links to GitHub repository
91- **Navigation**: Auto-generated sidebars
92- **SEO**: Metadata and sitemap generation
93- **Analytics**: Optional analytics integration
94 
95## Documentation Development
96```bash
97cd docs
98 
99# First time setup
100npm install
101 
102# Local development (hot reload)
103npm start
104 
105# Build for production
106npm run build
107 
108# Test production build locally
109npm run serve
110 
111# Clear cache if needed
112npm run clear
113```
114 
115## Deployment
116- Automatic deployment via GitHub Actions
117- Deploys to GitHub Pages on main branch
118- Custom domains supported
119- Version tagging for releases
120 
121## Best Practices
122- **Organization**:
123  - Group related topics together
124  - Use consistent page structure
125  - Create logical navigation flow
126- **Content**:
127  - Include practical examples
128  - Add screenshots for UI elements
129  - Provide troubleshooting sections
130- **Maintenance**:
131  - Update docs with each release
132  - Review for accuracy regularly
133  - Fix broken links promptly
134description:
135globs:
136alwaysApply: false
137---