254 lines
10 KiB
Markdown
254 lines
10 KiB
Markdown
# 🏠 AI Home Directory
|
|
|
|
> Your centralized knowledge base and project management office for AI-assisted development
|
|
|
|
---
|
|
|
|
## 📋 Table of Contents
|
|
- [Overview](#overview)
|
|
- [Repository Structure](#repository-structure)
|
|
- [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.
|
|
|
|
---
|
|
|
|
## 🏗️ Repository Structure
|
|
|
|
```
|
|
AI-Home-Directory/ # Mount point in containers
|
|
├── databank/ # 🔒 Readonly context (mounted readonly)
|
|
│ ├── personal/ # Personal information
|
|
│ │ ├── AboutMe.md
|
|
│ │ ├── StartHere.md
|
|
│ │ └── TSYS.md
|
|
│ ├── agents/ # AI agent guidelines
|
|
│ │ ├── AgentRules.md
|
|
│ │ ├── AGENTS.md
|
|
│ │ └── AI-TOOLS.md
|
|
│ ├── context/ # General context information
|
|
│ │ ├── AUDIT1.md
|
|
│ │ └── PROJECT-MGMT-TOOLS.md
|
|
│ ├── context/ # General context information
|
|
│ │ ├── AUDIT1.md
|
|
│ │ └── PROJECT-MGMT-TOOLS.md
|
|
│ ├── operations/ # Operational environment information
|
|
│ │ └── OPERATIONS-KNOWLEDGE-TRANSFER.md
|
|
│ └── templates/ # Template files for projects
|
|
│ └── OPS-ENVIRONMENT.md
|
|
├── pmo/ # ✏️ Read-write PMO (mounted read-write)
|
|
│ ├── dashboard/ # PMO dashboard views
|
|
│ ├── projects/ # Project registry and links
|
|
│ ├── reports/ # Status reports
|
|
│ ├── resources/ # Resource management
|
|
│ └── config/ # PMO configuration
|
|
├── collab/ # Project-specific collaboration (not mounted)
|
|
│ ├── rules/ # Project-specific rules
|
|
│ ├── env/ # Project-specific environment configs
|
|
│ ├── proposals/ # Project-specific proposals
|
|
│ └── temporary/ # Temporary collaboration files
|
|
├── databank/ # 🔒 Readonly context (mounted readonly)
|
|
│ ├── personal/ # Personal information
|
|
│ │ ├── AboutMe.md
|
|
│ │ ├── StartHere.md
|
|
│ │ └── TSYS.md
|
|
│ ├── agents/ # AI agent guidelines
|
|
│ │ ├── AgentRules.md
|
|
│ │ ├── AGENTS.md
|
|
│ │ └── AI-TOOLS.md
|
|
│ ├── context/ # General context information
|
|
│ │ ├── AUDIT1.md
|
|
│ │ └── PROJECT-MGMT-TOOLS.md
|
|
│ ├── operations/ # Operational environment information
|
|
│ │ └── OPERATIONS-KNOWLEDGE-TRANSFER.md
|
|
│ └── templates/ # Template files for projects
|
|
│ └── OPS-ENVIRONMENT.md
|
|
├── pmo/ # ✏️ Read-write PMO (mounted read-write)
|
|
│ ├── artifacts/ # PMO components and data
|
|
│ │ ├── dashboard/ # PMO dashboard views
|
|
│ │ ├── projects/ # Project registry and links
|
|
│ │ ├── reports/ # Status reports
|
|
│ │ ├── resources/ # Resource management
|
|
│ │ ├── config/ # PMO configuration
|
|
│ │ └── docs/ # PMO documentation
|
|
│ └── collab/ # PMO-specific collaboration
|
|
└── README.md # This file
|
|
```
|
|
|
|
---
|
|
|
|
## 🐳 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
|
|
- **collab/**: 🚫 Not mounted - Project-specific collaboration
|
|
|
|
---
|
|
|
|
## 📚 Databank (Readonly)
|
|
|
|
The databank directory contains readonly information that provides consistent context across projects.
|
|
|
|
### Personal Information (`databank/personal/`)
|
|
| File | Purpose |
|
|
|------|---------|
|
|
| [**AboutMe.md**](./databank/personal/AboutMe.md) | Personal information and professional background |
|
|
| [**StartHere.md**](./databank/personal/StartHere.md) | Onboarding guide for this directory |
|
|
| [**TSYS.md**](./databank/personal/TSYS.md) | Business information and organizational structure |
|
|
|
|
### Agent Guidelines (`databank/agents/`)
|
|
| File | Purpose |
|
|
|------|---------|
|
|
| [**AgentRules.md**](./databank/agents/AgentRules.md) | Operational guidelines for AI agents |
|
|
| [**AGENTS.md**](./databank/agents/AGENTS.md) | Guidelines for AI agents working with this repo |
|
|
| [**AI-TOOLS.md**](./databank/agents/AI-TOOLS.md) | AI tool preferences and usage patterns |
|
|
|
|
### Context Information (`databank/context/`)
|
|
| File | Purpose |
|
|
|------|---------|
|
|
| [**AUDIT1.md**](./databank/context/AUDIT1.md) | Analysis and improvement suggestions (template/example) |
|
|
| [**PROJECT-MGMT-TOOLS.md**](./databank/context/PROJECT-MGMT-TOOLS.md) | CLI project management tool recommendations |
|
|
|
|
### Templates (`databank/templates/`)
|
|
| File | Purpose |
|
|
|------|---------|
|
|
| [**OPS-ENVIRONMENT.md**](./databank/templates/OPS-ENVIRONMENT.md) | Operational environment template |
|
|
|
|
### Operations (`databank/operations/`)
|
|
| File | Purpose |
|
|
|------|---------|
|
|
| [**OPERATIONS-KNOWLEDGE-TRANSFER.md**](./databank/operations/OPERATIONS-KNOWLEDGE-TRANSFER.md) | Knowledge transfer interview for operational roles |
|
|
|
|
*Note: All databank files are readonly for AI agents*
|
|
|
|
---
|
|
|
|
## 📊 PMO (Read-Write)
|
|
|
|
The PMO directory contains project management functionality where AI agents can update project status and milestones.
|
|
|
|
### PMO Components
|
|
| Directory | Purpose |
|
|
|-----------|---------|
|
|
| **[pmo/artifacts/](./pmo/artifacts/)** | PMO components and data |
|
|
| **[pmo/artifacts/dashboard/](./pmo/artifacts/dashboard/)** | PMO dashboard views and reports |
|
|
| **[pmo/artifacts/projects/](./pmo/artifacts/projects/)** | Project registry and tracking links |
|
|
| **[pmo/artifacts/reports/](./pmo/artifacts/reports/)** | Status reports and analytics |
|
|
| **[pmo/artifacts/resources/](./pmo/artifacts/resources/)** | Resource allocation and management |
|
|
| **[pmo/artifacts/config/](./pmo/artifacts/config/)** | PMO configuration and settings |
|
|
| **[pmo/artifacts/docs/](./pmo/artifacts/docs/)** | Detailed PMO documentation |
|
|
| **[pmo/collab/](./pmo/collab/)** | 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/index.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, Claude) |
|
|
|
|
---
|
|
|
|
## 🚀 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
|
|
- **🧠 Claude** - Used occasionally for specific tasks
|
|
|
|
---
|
|
|
|
## 📈 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
|
|
|
|
---
|
|
|
|
*Last updated: October 24, 2025*
|
|
*Part of the AIOS (AI Operating System) ecosystem* |