Skip to content

Commit 98b09be

Browse files
TexasCodingclaude
andcommitted
docs: Add Obsidian usage guidelines to CLAUDE.md
- Document requirement to use Obsidian for development plans - Add structure for organizing development docs in Obsidian - Provide examples of when to use Obsidian vs project files - Keep project repository focused on production code only This ensures multi-session plans and development documentation are properly tracked in Obsidian rather than cluttering the project with non-production files. 🤖 Generated with Claude Code Co-Authored-By: Claude <[email protected]>
1 parent 2f768f9 commit 98b09be

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

CLAUDE.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,62 @@ The standardized deprecation utilities provide:
6464
- Metadata tracking for deprecation management
6565
- Support for functions, methods, classes, and parameters
6666

67+
## Development Documentation with Obsidian
68+
69+
### Important: Use Obsidian for Development Plans and Progress Tracking
70+
71+
**ALWAYS use Obsidian MCP integration for**:
72+
- Multi-session development plans
73+
- Testing procedures and results
74+
- Architecture decisions and design documents
75+
- Feature planning and roadmaps
76+
- Bug investigation notes
77+
- Performance optimization tracking
78+
- Release planning and checklists
79+
80+
**DO NOT create project files for**:
81+
- Personal development notes (use Obsidian instead)
82+
- Temporary planning documents
83+
- Testing logs and results
84+
- Work-in-progress documentation
85+
- Meeting notes or discussions
86+
87+
### Obsidian Structure for ProjectX Development
88+
89+
When using Obsidian for this project, use the following structure:
90+
```
91+
Development/
92+
ProjectX SDK/
93+
Feature Planning/
94+
[Feature Name].md
95+
Testing Plans/
96+
[Version] Release Testing.md
97+
Architecture Decisions/
98+
[Decision Topic].md
99+
Bug Investigations/
100+
[Issue Number] - [Description].md
101+
Performance/
102+
[Optimization Area].md
103+
```
104+
105+
### Example Obsidian Usage
106+
107+
```python
108+
# When creating multi-session plans:
109+
await mcp__mcp_obsidian__obsidian_append_content(
110+
filepath="Development/ProjectX SDK/Feature Planning/WebSocket Improvements.md",
111+
content="# WebSocket Connection Improvements Plan\n..."
112+
)
113+
114+
# When documenting test results:
115+
await mcp__mcp_obsidian__obsidian_append_content(
116+
filepath="Development/ProjectX SDK/Testing Plans/v3.3.0 Release Testing.md",
117+
content="## Test Results\n..."
118+
)
119+
```
120+
121+
This keeps the project repository clean and focused on production code while maintaining comprehensive development documentation in Obsidian.
122+
67123
## Development Commands
68124

69125
### Package Management (UV)

0 commit comments

Comments
 (0)