diff --git a/README.md b/README.md index 679aae8..d1bd20e 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,49 @@ -# GUIDEBOOK Index +# AI Home Directory -Welcome to the AIOS-Public GUIDEBOOK - your comprehensive guide to the AI Operating System template. +Welcome to my AI Home Directory - a centralized knowledge base and context repository that serves as the foundation for all my AI-assisted development work. ## Overview -The GUIDEBOOK contains essential documentation that serves as the foundation for all AIOS projects. Each document has a specific purpose in the AIOS ecosystem. -## Document List +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. + +## Purpose + +After a year of heavy AI utilization and several weeks working with AI CLI agents (Qwen, Gemini, Claude Code, Codex), I've developed a portable and reproducible development environment using Docker. This repository represents the constant, foundational context that every project needs access to. + +## Repository Structure ### [AboutMe.md](./AboutMe.md) -Personal information about Charles N Wyble (@ReachableCEO), including background, philosophy, and professional details. +Personal information and professional background that provides context for my work. ### [AgentRules.md](./AgentRules.md) Operational guidelines for AI agents, including interaction rules, workflow patterns, and technical guidelines. -### [ArchitecturalApproach.md](./ArchitecturalApproach.md) -Technical architecture patterns, including container architecture, security patterns, operational patterns, and implementation workflow. - ### [StartHere.md](./StartHere.md) -Onboarding guide explaining the purpose of the AIOS-Public repository as a template for launching new projects. +Onboarding guide explaining the purpose of this directory and how it fits into my development workflow. ### [TSYS.md](./TSYS.md) -Business information about the TSYS Group, including legal entities and organizational structure. +Business information about my organizational structure and related entities. ### [AUDIT1.md](./AUDIT1.md) -First comprehensive audit of the GUIDEBOOK, containing analysis and improvement suggestions. +Comprehensive analysis and improvement suggestions for my AI workflow and documentation. -## How to Use This Template -1. Clone this repository to create a new project -2. Review the documentation in the order above to understand the AIOS approach -3. Follow the architectural patterns outlined in ArchitecturalApproach.md -4. Apply the operational guidelines from AgentRules.md in your project work -5. Customize documentation as needed for your specific project +### [AGENTS.md](./AGENTS.md) +Guidelines for AI agents working with this repository, including commit conventions and workflow instructions. -## Relationship to Other AIOS Editions -- This is the Public edition of AIOS -- Two other editions exist as subsets: Personal and Private -- 80% of focus is on public work, with the rest in personal/private editions \ No newline at end of file +## Architecture + +This repository was previously a combined collection of my personal "AI databank" and Docker artifacts. The Docker artifacts have now been moved to a dedicated repository, leaving this as the pure "AI home directory" that maintains consistent context across all projects. + +## Workflow + +1. This directory is mounted into all development containers as a consistent knowledge base +2. Combined with project-specific context and prompts as needed +3. Provides continuity and reduces repetitive explanation of context to AI agents +4. Maintains consistent operational patterns across different projects + +## Benefits + +- **Consistency**: All projects have access to the same foundational knowledge +- **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 \ No newline at end of file