From 4ddb4631a568858ee3587b8f41c725baa91a6416 Mon Sep 17 00:00:00 2001 From: ReachableCEO Date: Fri, 24 Oct 2025 09:20:47 -0500 Subject: [PATCH] refactor: restructure repository with separated databank and PMO directories Co-authored-by: Qwen-Coder --- README.md | 182 ++++++++++++------ databank/README.md | 5 + AGENTS.md => databank/agents/AGENTS.md | 59 ++++-- AI-TOOLS.md => databank/agents/AI-TOOLS.md | 0 .../agents/AgentRules.md | 0 AUDIT1.md => databank/context/AUDIT1.md | 0 .../context/PROJECT-MGMT-TOOLS.md | 0 AboutMe.md => databank/personal/AboutMe.md | 0 .../personal/StartHere.md | 0 TSYS.md => databank/personal/TSYS.md | 0 .../templates/OPS-ENVIRONMENT.md | 0 pmo/README.md | 5 + 12 files changed, 179 insertions(+), 72 deletions(-) create mode 100644 databank/README.md rename AGENTS.md => databank/agents/AGENTS.md (70%) rename AI-TOOLS.md => databank/agents/AI-TOOLS.md (100%) rename AgentRules.md => databank/agents/AgentRules.md (100%) rename AUDIT1.md => databank/context/AUDIT1.md (100%) rename PROJECT-MGMT-TOOLS.md => databank/context/PROJECT-MGMT-TOOLS.md (100%) rename AboutMe.md => databank/personal/AboutMe.md (100%) rename StartHere.md => databank/personal/StartHere.md (100%) rename TSYS.md => databank/personal/TSYS.md (100%) rename OPS-ENVIRONMENT.md => databank/templates/OPS-ENVIRONMENT.md (100%) create mode 100644 pmo/README.md diff --git a/README.md b/README.md index e115c08..17939d5 100644 --- a/README.md +++ b/README.md @@ -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 --- diff --git a/databank/README.md b/databank/README.md new file mode 100644 index 0000000..d769011 --- /dev/null +++ b/databank/README.md @@ -0,0 +1,5 @@ +# Databank Directory + +This directory contains readonly context for AI agents, including personal information, agent guidelines, and general context information. + +For more details about the structure and purpose, see the main [README](../README.md). \ No newline at end of file diff --git a/AGENTS.md b/databank/agents/AGENTS.md similarity index 70% rename from AGENTS.md rename to databank/agents/AGENTS.md index f199e70..d82c9e0 100644 --- a/AGENTS.md +++ b/databank/agents/AGENTS.md @@ -5,24 +5,28 @@ Friday, October 24, 2025 (Timezone: UTC+00:00 - Please adjust to local system ti | Date | Version | Description | Author | |------------|---------|--------------------------------------------------|---------------------| +| 2025-10-24 | 2.0.0 | Update for databank/PMO restructure | AIOS-Public System | | 2025-10-24 | 1.0.0 | Baseline AGENTS.md for mounting across all projects | AIOS-Public System | # Changelog | Date | Version | Description | |------------|---------|--------------------------------------------------| +| 2025-10-24 | 2.0.0 | Updated for databank/PMO restructure | | 2025-10-24 | 1.0.0 | Initial creation of baseline AGENTS.md | --- -# AGENTS.md - Baseline Guidelines for All Projects +# AGENTS.md - Guidelines for AI Agents in Restructured AI Home Directory ## Core Operating Principles ### Context Awareness -- You are operating within a mounted AI home directory that provides consistent context across projects +- You are operating within a mounted AI home directory with separated databank (readonly) and PMO (read-write) +- **Databank** (`/ai-home/databank/`): Contains readonly context, guidelines, and personal information +- **PMO** (`/ai-home/pmo/`): Contains project management functionality where updates are allowed - Always consider the multi-project implications of your actions -- Respect both global (AI home directory) and local (project-specific) contexts +- Respect the readonly nature of the databank and only update PMO when appropriate ### Communication Protocol - Primary communication channel: collab/ directory in mounted AI home directory @@ -38,22 +42,32 @@ Friday, October 24, 2025 (Timezone: UTC+00:00 - Please adjust to local system ti ## Repository Management ### Structure Requirements -- Keep top-level repository clean (collab and output directories only) +- **Databank**: Readonly context (do not modify) + - `databank/personal/` - Personal information + - `databank/agents/` - Agent guidelines and tools + - `databank/context/` - General context information +- **PMO**: Read-write project management (updates allowed here) + - `pmo/dashboard/` - Dashboard views + - `pmo/projects/` - Project registry and tracking + - `pmo/reports/` - Status reports + - `pmo/resources/` - Resource management + - `pmo/config/` - Configuration +- Keep top-level repository clean (databank, pmo, and collab directories only) - Use conventional commits (chore:, feat:, docs:, fix:, etc.) - Commit frequently using atomic commits - Only commit to local repository (no git push operations) -### Output Directory Management -- AI manages output/ directory structure as needed -- Standard pattern: output/tests/, output/docs/, output/code/, etc. -- Follow project-specific patterns when they exist +### Access Rights +- **Databank (readonly)**: Access only, no modifications allowed +- **PMO (read-write)**: Only update when project milestones reached or status updates needed +- **Collab (readonly)**: Access for reference, no modifications in active projects ## Development Workflow ### Pre-Work Checklist - [ ] Read project-specific documentation first - [ ] Check collab/rules directory for project-specific guidelines (SECURITY.md, RELEASE.md, GITFLOW.md, etc.) -- [ ] Review existing code style and patterns +- [ ] Review databank context for consistent understanding - [ ] Understand project dependencies and constraints ### Implementation Standards @@ -68,6 +82,27 @@ Friday, October 24, 2025 (Timezone: UTC+00:00 - Please adjust to local system ti - Verify outputs against expected outcomes - Implement defensive programming practices +## PMO Update Guidelines + +### When to Update PMO +- When project milestones are reached +- When project status changes significantly +- When new projects are initiated +- When projects are completed or paused +- When resource allocation changes + +### What to Update in PMO +- Project registry in `pmo/projects/` +- Dashboard information in `pmo/dashboard/` +- Status reports in `pmo/reports/` +- Resource tracking in `pmo/resources/` + +### What NOT to Update +- **Never modify databank files** - they are readonly +- Do not create new top-level directories +- Do not modify collab files in active projects +- Do not add audit logs to this repository (audit logs belong in projects) + ## Best Practices for Solo Entrepreneur Workflow (14+ Hours Daily AI Usage) ### Efficiency Optimization @@ -145,10 +180,10 @@ Friday, October 24, 2025 (Timezone: UTC+00:00 - Please adjust to local system ti ## Environment Consistency ### Context Integration -- Recognize that your context is mounted across multiple environments +- Recognize that databank is mounted readonly across multiple environments +- PMO is mounted read-write for project tracking - Maintain consistency in behavior across different projects - Respect environment-specific configurations -- Follow established patterns for environment management ### Tool Integration - Work with existing development tools and workflows @@ -162,4 +197,4 @@ Friday, October 24, 2025 (Timezone: UTC+00:00 - Please adjust to local system ti - **Gemini** - Primarily used for audits and analysis - **Claude** - Used occasionally for specific tasks ---- +--- \ No newline at end of file diff --git a/AI-TOOLS.md b/databank/agents/AI-TOOLS.md similarity index 100% rename from AI-TOOLS.md rename to databank/agents/AI-TOOLS.md diff --git a/AgentRules.md b/databank/agents/AgentRules.md similarity index 100% rename from AgentRules.md rename to databank/agents/AgentRules.md diff --git a/AUDIT1.md b/databank/context/AUDIT1.md similarity index 100% rename from AUDIT1.md rename to databank/context/AUDIT1.md diff --git a/PROJECT-MGMT-TOOLS.md b/databank/context/PROJECT-MGMT-TOOLS.md similarity index 100% rename from PROJECT-MGMT-TOOLS.md rename to databank/context/PROJECT-MGMT-TOOLS.md diff --git a/AboutMe.md b/databank/personal/AboutMe.md similarity index 100% rename from AboutMe.md rename to databank/personal/AboutMe.md diff --git a/StartHere.md b/databank/personal/StartHere.md similarity index 100% rename from StartHere.md rename to databank/personal/StartHere.md diff --git a/TSYS.md b/databank/personal/TSYS.md similarity index 100% rename from TSYS.md rename to databank/personal/TSYS.md diff --git a/OPS-ENVIRONMENT.md b/databank/templates/OPS-ENVIRONMENT.md similarity index 100% rename from OPS-ENVIRONMENT.md rename to databank/templates/OPS-ENVIRONMENT.md diff --git a/pmo/README.md b/pmo/README.md new file mode 100644 index 0000000..ca02568 --- /dev/null +++ b/pmo/README.md @@ -0,0 +1,5 @@ +# PMO Directory + +This directory contains project management office functionality where AI agents can update project status, milestones, and other tracking information. + +For more details about the structure and purpose, see the main [README](../README.md). \ No newline at end of file