43 lines
839 B
Markdown
43 lines
839 B
Markdown
# Development Notes
|
|
|
|
This directory contains development notes and documentation organized by topic and date.
|
|
|
|
## Structure
|
|
|
|
- Each note is stored as a markdown file
|
|
- Files are organized by topic in subdirectories
|
|
- File naming format: `YYYY-MM-DD_topic_name.md`
|
|
- Each note includes:
|
|
- Date
|
|
- Topic/Category
|
|
- Content
|
|
- Related files/components
|
|
- Action items (if any)
|
|
|
|
## How to Add Notes
|
|
|
|
1. Create a new markdown file with the date prefix
|
|
2. Use the standard note template
|
|
3. Place in appropriate topic directory
|
|
4. Link related notes if applicable
|
|
|
|
## Note Template
|
|
|
|
```markdown
|
|
# [Topic] - [Date]
|
|
|
|
## Overview
|
|
Brief description of the topic/issue
|
|
|
|
## Details
|
|
Main content of the note
|
|
|
|
## Related
|
|
- Links to related files/components
|
|
- References to other notes
|
|
|
|
## Action Items
|
|
- [ ] Todo items if any
|
|
- [ ] Next steps
|
|
```
|