This folder contains formal documentation, reports, and reference materials for the meta-dynamicdevices project.
Purpose: Security compliance reports and assessments
Audience: Technical leadership, C-suite, regulatory bodies
Contents: Formal security compliance reports with versioning and git commit references
Purpose: Build reports, testing results, and project status documents
Audience: Project managers, technical leads
Contents: Build-specific reports, testing checklists, issues tracking, next steps
Purpose: Technical investigation reports and research findings
Audience: Engineers, technical team
Contents: Deep-dive technical investigations, security research, implementation analysis
Purpose: Template files and examples
Audience: Developers
Contents: Recipe templates, configuration examples, boilerplate files
Purpose: Hardware datasheets and reference materials
Audience: Hardware engineers, developers
Contents: Component datasheets, hardware specifications
Purpose: Archived documentation and historical records
Audience: Reference only
Contents: Deprecated documentation, historical reports
For day-to-day engineering documentation, guides, and tutorials, see the wiki/ folder.
The wiki contains:
- Development guides and workflows
- Hardware reference materials
- Feature implementation guides
- Troubleshooting documentation
- Quick-start guides
- Engineering Guides →
wiki/(maintainable, living documentation) - Formal Reports →
docs/reports/(versioned, point-in-time) - Security Assessments →
docs/security/(compliance, regulatory) - Technical Research →
docs/investigations/(research findings) - Templates →
docs/templates/(reusable patterns)
- Wiki: Updated continuously by engineers
- Reports: Created as needed, archived when superseded
- Security: Generated periodically with versioning
- Investigations: Created for specific research, referenced long-term
- Templates: Updated when patterns change
Keep this structure clean and purposeful. Move engineering guides to wiki, formal reports here.