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

refactor: restructure repository with separated databank and PMO directories

Browse Source 
Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com>
This commit is contained in:
Charles N Wyble - admin
2025-10-24 09:20:47 -05:00
parent b496e70147
commit 4ddb4631a5
12 changed files with 179 additions and 72 deletions
Download Patch File Download Diff File Expand all files Collapse all files

182
README.md
View File

@@ -1,15 +1,15 @@
# 🏠 AI Home Directory
> Your centralized knowledge base and context repository for AI-assisted development
> Your centralized knowledge base and project management office for AI-assisted development
---
## 📋 Table of Contents
- [Overview](#overview)
- [Architecture](#architecture)
- [Repository Structure](#repository-structure)
- [Workflow](#workflow)
- [Benefits](#benefits)
- [Mounting in Containers](#mounting-in-containers)
- [Databank (Readonly)](#databank-readonly)
- [PMO (Read-Write)](#pmo-read-write)
- [Usage](#usage)
---
@@ -18,88 +18,147 @@
| Aspect | Description |
|--------|-------------|
| **Purpose** | Centralized "AI home directory" mounted in all development containers |
| **Function** | Provides consistent context across all projects |
| **Integration** | Combined with project-specific prompts as needed |
| **Status** | Actively evolving knowledge base |
| **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" that gets mounted into all development project stacks (containers). It provides critical, consistent context across all projects while being combined with project-specific prompts as needed.
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.
---
## 🔧 Architecture
## 🏗️ Repository Structure
```
┌─────────────────────────────────────────────────────────────┐
│ Development Container │
├─────────────────────────────────────────────────────────────┤
│ ┌─────────────────┐ ┌─────────────────────────────────┐ │
│ │ │ │ │ │
│ │ Project-Specific│ │ 🏠 AI HOME DIRECTORY │ │
│ │ Context │ │ (Mounted Volume) │ │
│ │ │ │ │ │
│ │ - Project docs │ │ - Agent Rules │ │
│ │ - Codebase │ │ - Personal Info │ │
│ │ - Requirements │ │ - Workflow Guides │ │
│ └─────────────────┘ │ - Business Context │ │
│ │ - (Audit Logs in Project) │ │
│ └─────────────────────────────────┘ │
└─────────────────────────────────────────────────────────────┘
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
│ └── 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/ # Collaboration directory (readonly)
│ └── proposals/ # Proposals and planning
│ ├── PMO/
│ └── ...
└── README.md # This file
```
### Evolution from Previous State
| Previous State | Current State |
|----------------|---------------|
| Combined AI databank + Docker artifacts | Dedicated AI home directory |
| Monolithic repository | Focused context repository |
| Project-specific | Universal context base |
| Docker artifacts included | Docker artifacts moved to dedicated repo |
---
## 📚 Repository Structure
## 🐳 Mounting in Containers
| File | Purpose | Last Updated |
|------|---------|--------------|
| [**AboutMe.md**](./AboutMe.md) | Personal information and professional background | Dynamic |
| [**AgentRules.md**](./AgentRules.md) | Operational guidelines for AI agents | Dynamic |
| [**StartHere.md**](./StartHere.md) | Onboarding guide for this directory | Dynamic |
| [**TSYS.md**](./TSYS.md) | Business information and organizational structure | Dynamic |
| [**AUDIT1.md**](./AUDIT1.md) | Analysis and improvement suggestions (template/example) | Static |
| [**AGENTS.md**](./AGENTS.md) | Guidelines for AI agents working with this repo | Dynamic |
### 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
```
*Note: All files are actively evolving as the knowledge base expands (except audit templates which belong in projects)*
### Permission Boundaries
- **databank/**: 🔒 Read-only access (ro) - Consistent context for all tools
- **pmo/**: ✏️ Read-write access (rw) - Project management updates
- **collab/**: 🔒 Read-only access (ro) - Collaboration guidelines
---
## 📚 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 |
*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/dashboard/** | PMO dashboard views and reports |
| **pmo/projects/** | Project registry and tracking links |
| **pmo/reports/** | Status reports and analytics |
| **pmo/resources/** | Resource allocation and management |
| **pmo/config/** | PMO configuration and settings |
### 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
---
## 🔄 Workflow
### Primary Flow
1. **Mount** → This directory is mounted into all development containers
2. **Combine** → Merged with project-specific context and prompts
3. **Access** → AI agents have consistent readonly knowledge across projects
4. **Update PMO Only** → Agents update only the PMO in this repository (milestones, progress)
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**: Available to all AI agents as readonly reference
- 📦 **Containerized**: Works with Docker-based development
- 🌐 **Universal Context**: Databank available as readonly reference
- 📊 **PMO Updates**: Agents update project status in PMO only
- ⚡ **Efficient**: Eliminates repetitive context explanation
- 🔄 **Synchronized**: Single source of truth for core knowledge
- 📊 **PMO Updates**: Agents update PMO with project milestones and status only
- 🔐 **Secure**: Clear permission boundaries for container mounting
---
## ✅ Benefits
| Benefit | Impact |
|---------|--------|
| **🎯 Consistency** | All projects have access to the same foundational knowledge |
|---------|---------|
| **🎯 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 CLI tools (Qwen, Gemini, Claude, Codex) |
| **🔗 Integration** | Seamless with existing AI tools (Codex, Qwen, Gemini, Claude) |
---
@@ -110,8 +169,11 @@ This repository functions as my personal "AI home directory" that gets mounted i
# Clone the repository
git clone ssh://git@git.knownelement.com:29418/reachableceo/ReachableCEO-AI-Homedir-Public.git
# Mount in your Docker development environment
docker run -v /path/to/AI-Home-Directory:/ai-home your-development-image
# 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
@@ -128,8 +190,8 @@ docker run -v /path/to/AI-Home-Directory:/ai-home your-development-image
### Planned Enhancements
- [ ] Additional context files for specific domains
- [ ] Enhanced agent interaction patterns
- [ ] Integration with more AI platforms
- [ ] Enhanced PMO dashboard functionality
- [ ] Integration with more project management tools
- [ ] Improved documentation structure
---
@@ -141,7 +203,7 @@ Since this serves as a living knowledge base:
- Files follow **structured formats** for easy processing
- Regular updates ensure **current and relevant** information
- **Version control** maintains history and evolution
- **AI agents treat this as readonly** - only PMO updates allowed
- **AI agents treat databank as readonly** - only PMO updates allowed
- **Audit logs belong in projects**, not this repository
---