|
34 | 34 | - Use broadly applicable examples rather than overly specific business cases |
35 | 35 | - Lead with context when helpful - explain what something is before diving into implementation details |
36 | 36 |
|
| 37 | +### Style preferences (learned from content refresh project) |
| 38 | +#### Headings and formatting |
| 39 | +- Use sentence case for all headings ("Getting started", not "Getting Started") |
| 40 | +- Use "Properties" instead of "Props" for component documentation |
| 41 | +- Use sentence case for code block titles ("Expandable example", not "Expandable Example") |
| 42 | + |
| 43 | +#### Component introductions |
| 44 | +- Start with action-oriented language: "Use [component] to..." rather than "The [component] component..." |
| 45 | +- Be specific about what components can contain or do |
| 46 | +- Make introductions practical and user-focused |
| 47 | + |
| 48 | +#### Property descriptions |
| 49 | +- End all property descriptions with periods for consistency |
| 50 | +- Be specific and helpful rather than generic |
| 51 | +- Add scope clarification where needed (e.g., "For Font Awesome icons only:") |
| 52 | +- Use proper technical terminology ("boolean" not "bool") |
| 53 | + |
| 54 | +#### Language and tone |
| 55 | +- Prefer active voice and direct language |
| 56 | +- Remove unnecessary words while maintaining clarity |
| 57 | +- Use "you complete" over "completing" for more direct communication |
| 58 | +- Break complex instructions into clear numbered steps |
| 59 | +- Make language more precise and contextual |
| 60 | + |
| 61 | +#### Code examples |
| 62 | +- Keep examples simple and practical |
| 63 | +- Use consistent formatting and naming |
| 64 | +- Provide clear, actionable examples rather than showing multiple options when one will do |
| 65 | + |
| 66 | +#### Content organization |
| 67 | +- Structure content in the order users need it |
| 68 | +- Combine related information to reduce redundancy |
| 69 | +- Use specific links (direct to relevant pages rather than generic dashboards) |
| 70 | +- Put most commonly needed information first |
| 71 | + |
37 | 72 | ## Git workflow |
38 | 73 | - NEVER use --no-verify when committing |
39 | 74 | - Ask how to handle uncommitted changes before starting |
|
0 commit comments