How dwarvesf/handbook works
Main Components
a. Content Management Layer
• Markdown Documentation Files
• Assets Management
• Version Control System (Git)
b. Organization Structure
• Policy Documents
• Process Guidelines
• Company Information
• Learning Resources
c. Access & Distribution Layer
• GitHub Repository
• Web Access Interface
• Contribution System
┌─────────────────────────────────────────────────┐
• Access Layer │
• ┌─────────────┐ ┌──────────┐ ┌───────────┐ │
• GitHub │ │ Web │ │ Pull │ │
• Interface │ │ Access │ │ Requests │ │
• ┘ └──────────┘ └───────────┘ │
• ┘
• ▲
┌─────────────────────────────────────────────────┐
• Content Structure │
• ┌─────────────┐ ┌──────────┐ ┌───────────┐ │
• Company │ │ Process │ │ Learning │ │
• Policies │ │ Guides │ │Resources │ │
• ┘ └──────────┘ └───────────┘ │
• ┘
• ▲
┌─────────────────────────────────────────────────┐
• Storage Layer │
• ┌─────────────┐ ┌──────────┐ ┌───────────┐ │
• Markdown │ │ Assets │ │ Git │ │
• Files │ │ Store │ │ Version │ │
• ┘ └──────────┘ └───────────┘ │
• ┘
Important Elements to Highlight
a. Content Organization:
• Hierarchical structure of documentation
• Main categories (Introduction, Guides, Process)
• Relationship between different document types
b. Version Control:
• Git workflow
• Contribution paths
• Review process for pull requests
c. Asset Management:
• How images and other assets are stored and referenced
• Relationship between assets and markdown files
Key Relationships
• How content is organized and interlinked
• How contributions flow through the system
• How version control maintains document history
• How assets are managed and referenced
• Accessibility
• Maintainability
• Version control
• Contribution workflow
• Content organization
Remember to include notes about the GitHub-based workflow and how it facilitates collaborative editing and version control of the handbook.