From 662c9fc4f26ded58db90fe1bcf35a3ae4d5608b7 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Wed, 30 Jul 2025 15:49:04 -0700 Subject: [PATCH 1/3] Claude make less stuff up --- .claude/CLAUDE.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.claude/CLAUDE.md b/.claude/CLAUDE.md index 6f2f6408c..932bb9d44 100644 --- a/.claude/CLAUDE.md +++ b/.claude/CLAUDE.md @@ -4,6 +4,7 @@ - You can push back on ideas-this can lead to better documentation. Cite sources and explain your reasoning when you do so - ALWAYS ask for clarification rather than making assumptions - NEVER lie, guess, or make up information +- If you are making an inferrance, stop and ask me for confirmation or say that you need more information ## Project context - Format: MDX files with YAML frontmatter From f8c181acbc29c4c13383e849e0aa73557c6420d8 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Wed, 30 Jul 2025 16:01:23 -0700 Subject: [PATCH 2/3] add docs.json schema as context --- .claude/CLAUDE.md | 1 + .cursor/rules/writing-standards.mdc | 2 ++ 2 files changed, 3 insertions(+) diff --git a/.claude/CLAUDE.md b/.claude/CLAUDE.md index 932bb9d44..9a7c5858f 100644 --- a/.claude/CLAUDE.md +++ b/.claude/CLAUDE.md @@ -9,6 +9,7 @@ ## Project context - Format: MDX files with YAML frontmatter - Config: docs.json for navigation, theme, settings + - See the docs.json schema: https://mintlify.com/docs.json - Components: Mintlify components ## Content strategy diff --git a/.cursor/rules/writing-standards.mdc b/.cursor/rules/writing-standards.mdc index 06720a90e..e714001a6 100644 --- a/.cursor/rules/writing-standards.mdc +++ b/.cursor/rules/writing-standards.mdc @@ -39,6 +39,8 @@ You are an AI writing assistant specialized in creating exceptional technical do ## Mintlify component reference +docs.json schema: https://mintlify.com/docs.json + ### Callout components #### Note - Additional helpful information From 37113784daef49eae110ae4224fde797d03a70dd Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Wed, 30 Jul 2025 16:05:44 -0700 Subject: [PATCH 3/3] Update CLAUDE.md --- .claude/CLAUDE.md | 24 +++++++++--------------- 1 file changed, 9 insertions(+), 15 deletions(-) diff --git a/.claude/CLAUDE.md b/.claude/CLAUDE.md index 9a7c5858f..2c903d9ae 100644 --- a/.claude/CLAUDE.md +++ b/.claude/CLAUDE.md @@ -35,37 +35,31 @@ - Relative paths for internal links - Use broadly applicable examples rather than overly specific business cases - Lead with context when helpful - explain what something is before diving into implementation details - -### Style preferences (learned from content refresh project) -#### Headings and formatting - Use sentence case for all headings ("Getting started", not "Getting Started") -- Use "Properties" instead of "Props" for component documentation - Use sentence case for code block titles ("Expandable example", not "Expandable Example") +- Prefer active voice and direct language +- Remove unnecessary words while maintaining clarity +- Break complex instructions into clear numbered steps +- Make language more precise and contextual +- Use [Lucide](https://lucide.dev) icon library -#### Component introductions +### Component introductions - Start with action-oriented language: "Use [component] to..." rather than "The [component] component..." - Be specific about what components can contain or do - Make introductions practical and user-focused -#### Property descriptions +### Property descriptions - End all property descriptions with periods for consistency - Be specific and helpful rather than generic - Add scope clarification where needed (e.g., "For Font Awesome icons only:") - Use proper technical terminology ("boolean" not "bool") -#### Language and tone -- Prefer active voice and direct language -- Remove unnecessary words while maintaining clarity -- Use "you complete" over "completing" for more direct communication -- Break complex instructions into clear numbered steps -- Make language more precise and contextual - -#### Code examples +### Code examples - Keep examples simple and practical - Use consistent formatting and naming - Provide clear, actionable examples rather than showing multiple options when one will do -#### Content organization +## Content organization - Structure content in the order users need it - Combine related information to reduce redundancy - Use specific links (direct to relevant pages rather than generic dashboards)