Update documentation and add architectural approach document
This commit is contained in:
@@ -19,3 +19,8 @@ Additional Rules:
|
||||
- Create thin wrapper scripts that detect and handle UID/GID mapping to ensure file permissions work across any host environment.
|
||||
- Maintain disciplined naming and organization to prevent technical debt as the number of projects grows.
|
||||
- Keep the repository root directory clean. Place all project-specific files and scripts in appropriate subdirectories rather than at the top level.
|
||||
- Use conventional commits for all git commits with proper formatting: type(scope): brief description followed by more verbose explanation if needed.
|
||||
- Commit messages should be beautiful and properly verbose, explaining what was done and why.
|
||||
- Use the LLM's judgment for when to push and tag - delegate these decisions based on the significance of changes.
|
||||
- All projects should include a collab/ directory with subdirectories: questions, proposals, plans, prompts, and audit.
|
||||
- Follow the architectural approach: layered container architecture (base -> specialized layers), consistent security patterns (non-root user with UID/GID mapping), same operational patterns (wrapper scripts), and disciplined naming conventions.
|
||||
|
||||
47
GUIDEBOOK/ArchitecturalApproach.md
Normal file
47
GUIDEBOOK/ArchitecturalApproach.md
Normal file
@@ -0,0 +1,47 @@
|
||||
# Architectural Approach
|
||||
|
||||
This document captures the architectural approach for project development in the AIOS-Public system.
|
||||
|
||||
## Container Architecture
|
||||
|
||||
### Layered Approach
|
||||
- Base containers provide foundational tools and libraries
|
||||
- Specialized containers extend base functionality for specific use cases
|
||||
- Each layer adds specific capabilities while maintaining consistency
|
||||
|
||||
### Naming Convention
|
||||
- Use `RCEO-AIOS-Public-Tools-` prefix consistently
|
||||
- Include descriptive suffixes indicating container purpose
|
||||
- Follow pattern: `RCEO-AIOS-Public-Tools-[domain]-[type]`
|
||||
|
||||
### Security Patterns
|
||||
- Minimize root usage during build and runtime
|
||||
- Implement non-root users for all runtime operations
|
||||
- Use UID/GID mapping for proper file permissions across environments
|
||||
- Detect host user IDs automatically through file system inspection
|
||||
|
||||
### Operational Patterns
|
||||
- Create thin wrapper scripts that handle environment setup
|
||||
- Use consistent patterns for user ID detection and mapping
|
||||
- Maintain same operational workflow across all containers
|
||||
- Provide clear documentation in README files
|
||||
|
||||
### Organization Principles
|
||||
- Separate COO mode (operational tasks) from CTO mode (R&D tasks) containers
|
||||
- Create individual directories per container type
|
||||
- Maintain disciplined file organization to prevent technical debt
|
||||
- Keep repository root clean with project-specific files in subdirectories
|
||||
|
||||
## Documentation Requirements
|
||||
- Each container must have comprehensive README
|
||||
- Include usage examples and environment setup instructions
|
||||
- Document security and permission handling
|
||||
- Provide clear container mapping and purpose
|
||||
|
||||
## Implementation Workflow
|
||||
1. Start with architectural design document
|
||||
2. Create detailed implementation plan
|
||||
3. Develop following established patterns
|
||||
4. Test with sample data/usage
|
||||
5. Document for end users
|
||||
6. Commit with conventional commit messages
|
||||
Reference in New Issue
Block a user