17 lines
789 B
Markdown
17 lines
789 B
Markdown
|
Please help me maintain consistent documentation standards as established in my Linux home lab project. Key files to reference:
|
||
|
|
project-documentation-template.md - Base template for all projects
|
||
|
|
projects/01-homelab-setup/ - Example of implemented standards:
|
||
|
|
README.md - Main project documentation
|
||
|
|
security-setup.md - Component-specific details
|
||
|
|
lessons-learned.md - Learning outcomes and challenges
|
||
|
|
Documentation requirements:
|
||
|
|
Use markdown formatting
|
||
|
|
Include status indicators (✅, ⚠️, ❌)
|
||
|
|
Document commands with examples
|
||
|
|
Track both successes and challenges
|
||
|
|
Maintain separate files for:
|
||
|
|
Main project documentation
|
||
|
|
Detailed setup/configuration
|
||
|
|
Lessons learned
|
||
|
|
Quick reference guides
|
||
|
|
Please help ensure any new documentation follows these established patterns for portfolio consistency.
|