-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add comprehensive log file template
- Add detailed markdown template for log files - Update development guidelines - Include formatting requirements - Add cross-referencing guidelines - Update recent updates section
- Loading branch information
Showing
1 changed file
with
89 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,98 @@ | ||
# Development Progress | ||
|
||
## Current Status | ||
```yaml | ||
current_phase: "Documentation and Setup" | ||
next_milestone: "Core Systems Implementation" | ||
latest_update: "2025-01-15" | ||
## Log File Template | ||
|
||
Each log file should follow this format: | ||
|
||
```markdown | ||
--- | ||
title: [Month Day, Year] | ||
description: [Brief description of main focus] | ||
--- | ||
|
||
# Development Log: [Month Day, Year] | ||
|
||
## Session Focus | ||
- [Key area 1] | ||
- [Key area 2] | ||
- [Key area 3] | ||
|
||
## Changes Made | ||
|
||
### [Category 1 (e.g., Documentation)] | ||
- Major change 1 | ||
- Sub-detail | ||
- Sub-detail | ||
- Major change 2 | ||
- Sub-detail | ||
- Sub-detail | ||
|
||
### [Category 2 (e.g., Implementation)] | ||
- Major change 1 | ||
- Sub-detail | ||
- Sub-detail | ||
- Major change 2 | ||
- Sub-detail | ||
- Sub-detail | ||
|
||
## Technical Details | ||
- Specific implementation details | ||
- Configuration changes | ||
- Architecture decisions | ||
|
||
## Challenges and Solutions | ||
- **Challenge**: [Description of challenge] | ||
- **Solution**: [How it was resolved] | ||
|
||
- **Challenge**: [Description of challenge] | ||
- **Solution**: [How it was resolved] | ||
|
||
## Next Steps | ||
1. [Next action item] | ||
2. [Next action item] | ||
3. [Next action item] | ||
|
||
## References | ||
- [Link to relevant document](../../path/to/document.md) | ||
- [Link to relevant document](../../path/to/document.md) | ||
``` | ||
|
||
## Development Guidelines | ||
|
||
Each log entry should include: | ||
Each log entry should: | ||
|
||
1. **Start with YAML Frontmatter** | ||
- Include title and description | ||
- Use consistent date format (Month DD, YYYY) | ||
|
||
2. **Have Clear Sections** | ||
- Session Focus | ||
- Changes Made (with categories) | ||
- Technical Details | ||
- Challenges and Solutions | ||
- Next Steps | ||
- References | ||
|
||
3. **Use Proper Formatting** | ||
- Use markdown headers consistently | ||
- Include bullet points for lists | ||
- Format code blocks with appropriate syntax | ||
- Use relative links for cross-references | ||
|
||
4. **Be Detailed but Concise** | ||
- Focus on significant changes | ||
- Include enough context to understand the changes | ||
- Link to detailed documentation rather than repeating it | ||
|
||
* Key decisions made and their rationale | ||
* Technical implementation details | ||
* Challenges encountered and solutions | ||
* Next steps and TODOs | ||
5. **Include Cross-References** | ||
- Link to related documentation | ||
- Reference previous logs when relevant | ||
- Link to specific commits or PRs when applicable | ||
|
||
Format Guidelines: | ||
## Recent Updates | ||
|
||
* Use consistent headings (H1 for title, H2 for main sections) | ||
* Include code blocks with appropriate syntax highlighting | ||
* Link to relevant documentation and code | ||
* Add tags for easy categorization | ||
- [January 19, 2025](2025-01-19.md) - Documentation Structure and Navigation Improvements | ||
- [January 17, 2025](2025-01-17.md) - Health Monitoring and Docker Setup | ||
- [January 15, 2025](2025-01-15.md) - Project Setup and Initial Documentation | ||
- [January 13, 2025](2025-01-13.md) - Repository Structure and Development Environment | ||
- [January 09, 2025](2025-01-09.md) - Initial Project Planning |