reachableceo/ReachableCEO-AI-Homedir-Public
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
main
ReachableCEO-AI-Homedir-Public/README.md

210 lines
8.3 KiB
Markdown
Raw Permalink Blame History

# 🏠 AI Home Directory
> Your centralized knowledge base and project management office for AI-assisted development
---
## 📋 Table of Contents
- [Overview](#-overview)
- [Mounting in Containers](#-mounting-in-containers)
- [Databank (Readonly)](#-databank-readonly)
- [PMO (Read-Write)](#-pmo-read-write)
- [Usage](#-usage)
---
## 🧠 Overview
| Aspect | Description |
|--------|-------------|
| **Purpose** | Centralized "AI home directory" with separated readonly databank and read-write PMO |
| **Function** | Provides consistent context across all projects with managed project updates |
| **Integration** | Mounted in development containers with appropriate permissions |
| **Status** | Actively evolving knowledge base with structured PMO functionality |
This repository functions as my personal "AI home directory" with a clear separation between readonly context (databank) and managed project updates (PMO). The databank provides consistent context across all projects while the PMO tracks project status and manages updates.
---
## 🐳 Mounting in Containers
### Recommended Mount Pattern
```bash
# Separate mount points with clear permissions
docker run \
-v /path/to/AI-Home-Directory/databank:/ai-home/databank:ro \
-v /path/to/AI-Home-Directory/pmo:/ai-home/pmo:rw \
your-development-image
```
### Permission Boundaries
- **databank/**: 🔒 Read-only access (ro) - Consistent context for all tools
- **pmo/**: ✏️ Read-write access (rw) - Project management updates
---
## 📚 Databank (Readonly)
### Databank Artifacts (`databank/artifacts/`)
| Directory | Purpose |
|-----------|---------|
| [**databank/artifacts/human/**](./databank/artifacts/human/) | Human-friendly markdown files |
| [**databank/artifacts/llm/**](./databank/artifacts/llm/) | LLM-optimized structured data |
| [**databank/artifacts/README.md**](./databank/artifacts/README.md) | Canonical databank content |
### Collaboration (`databank/collab/`)
| Directory | Purpose |
|-----------|---------|
| [**databank/collab/**](./databank/collab/) | Space for human/AI interaction |
*Note: All databank files are readonly for AI agents except in collab/ directory*
The databank directory contains readonly information that provides consistent context across projects.
| Directory | Purpose |
|-----------|---------|
| [**databank/artifacts/docs/**](./databank/artifacts/docs/) | AI-managed documentation |
| [**databank/artifacts/code/**](./databank/artifacts/code/) | AI-managed code artifacts |
| [**databank/artifacts/config/**](./databank/artifacts/config/) | AI-managed configuration |
| [**databank/artifacts/templates/**](./databank/artifacts/templates/) | AI-managed templates |
*Note: All databank files are readonly for AI agents except in collab/ and artifacts/ directories*
---
## 📊 PMO (Read-Write)
The PMO (Project Management Office) directory contains project management functionality where AI agents can update project status and milestones. Project management/todo artifacts stay local to their project, and the PMO links to them. Projects will update the PMO using a defined structure/format/protocol.
### PMO Components
### PMO Scaffolding
| Directory | Purpose |
|-----------|---------|
| **[pmo/artifacts/scaffolding/](./pmo/artifacts/scaffolding/README.md)** | Templates for new PMO components |
| **[pmo/artifacts/scaffolding/domain-template/](./pmo/artifacts/scaffolding/domain-template/README.md)** | Template for new PMO domains |
| Directory | Purpose |
|-----------|---------|
| **[pmo/artifacts/](./pmo/artifacts/README.md)** | PMO components and data |
| **[pmo/artifacts/dashboard/](./pmo/artifacts/dashboard/README.md)** | PMO dashboard views and reports |
| **[pmo/artifacts/projects/](./pmo/artifacts/projects/README.md)** | Project registry and tracking links |
| **[pmo/artifacts/reports/](./pmo/artifacts/reports/README.md)** | Status reports and analytics |
| **[pmo/artifacts/resources/](./pmo/artifacts/resources/README.md)** | Resource allocation and management |
| **[pmo/artifacts/config/](./pmo/artifacts/config/README.md)** | PMO configuration and settings |
| **[pmo/artifacts/docs/](./pmo/artifacts/docs/README.md)** | Detailed PMO documentation |
| **[pmo/coo/](./pmo/coo/README.md)** | COO-specific project management |
| **[pmo/cto/](./pmo/cto/README.md)** | CTO-specific project management |
| **[pmo/cto/vpengineering/](./pmo/cto/vpengineering/README.md)** | VP Engineering project management |
| **[pmo/cto/vpproduct/](./pmo/cto/vpproduct/README.md)** | VP Product project management |
| **[pmo/collab/](./pmo/collab/README.md)** | PMO-specific collaboration |
### PMO Update Guidelines
- AI agents may only update PMO when milestones are reached
- Audit logs belong in individual project repositories
- Only PMO updates are allowed in this repository
- All other content in this repository is readonly
### Documentation
For detailed PMO documentation, see the [detailed documentation](./pmo/artifacts/docs/README.md).
---
## 🔄 Workflow
### Primary Flow
1. **Mount** → Databank mounted as readonly, PMO mounted as read-write
2. **Access** → AI agents have readonly knowledge from databank
3. **Update** → AI agents update PMO with project milestones and status
4. **Report** → PMO provides centralized project visibility
### Integration Pattern
- 🌐 **Universal Context**: Databank available as readonly reference
- 📊 **PMO Updates**: Agents update project status in PMO only
- ⚡ **Efficient**: Eliminates repetitive context explanation
- 🔐 **Secure**: Clear permission boundaries for container mounting
---
## ✅ Benefits
| Benefit | Impact |
|---------|---------|
| **🎯 Consistency** | All projects have access to the same foundational knowledge (databank) |
| **🔒 Security** | Clear permission boundaries with separate mount points |
| **⚡ Efficiency** | Eliminates need to repeatedly explain context to AI agents |
| **📈 Scalability** | Works seamlessly with multiple ongoing projects |
| **🔧 Maintainability** | Centralized updates propagate to all projects automatically |
| **⚙️ Continuity** | Provides continuity across different projects |
| **🔗 Integration** | Seamless with existing AI tools (Codex, Qwen, Gemini) |
---
## 🚀 Usage
### Getting Started
```bash
# Clone the repository
git clone ssh://git@git.knownelement.com:29418/reachableceo/ReachableCEO-AI-Homedir-Public.git
# Mount in your Docker development environment with proper permissions
docker run \
-v /path/to/AI-Home-Directory/databank:/ai-home/databank:ro \
-v /path/to/AI-Home-Directory/pmo:/ai-home/pmo:rw \
your-development-image
```
### Current AI Tools in Workflow
- **✨ Codex** - Primary daily driver (subscription-based)
- **🤖 Qwen** - Heavy system orchestration, shell/Docker expertise
- **🔍 Gemini** - Primarily for audits
---
## 📈 Active Development
> ⚠️ **Note**: This knowledge base is actively evolving over the coming hours with substantial updates to the databank.
### Planned Enhancements
- [ ] Additional context files for specific domains
- [ ] Enhanced PMO dashboard functionality
- [ ] Integration with more project management tools
- [ ] Improved documentation structure
---
## 🤝 Contributing to Context
Since this serves as a living knowledge base:
- All content is designed to be **machine-readable** for AI agents
- Files follow **structured formats** for easy processing
- Regular updates ensure **current and relevant** information
- **Version control** maintains history and evolution
- **AI agents treat databank as readonly** - only PMO updates allowed
- **Audit logs belong in projects**, not this repository
---
## 🔗 Integration Points
### Primary Integration
- **[TSYSDevStack](https://git.knownelement.com/KNEL/TSYSDevStack)** - Docker artifacts repository for development environment
---
## Change Tracking/Revision Table
| Date/Time | Version | Description | Author |
|----------------------|---------|--------------------------------------------------|---------------------|
| 2025-10-24 11:30 CDT | 1.0.2 | Fix repository structure duplication | Charles N Wyble (@ReachableCEO) |
| 2025-10-24 10:50 CDT | 1.0.1 | Update date format consistency | Charles N Wyble (@ReachableCEO) |
| 2025-10-24 10:34 CDT | 1.0.0 | Initial change tracking table for README | Charles N Wyble (@ReachableCEO) |
---
*Last updated: October 24, 2025*
Reference in New Issue View Git Blame Copy Permalink