From 6c8955fe4972fd1d877f369169a8cac907616906 Mon Sep 17 00:00:00 2001 From: nathan Date: Sun, 19 Apr 2026 16:30:42 -0400 Subject: [PATCH] docs: add CONTRIBUTIONS.md and update README.md for clarity and guidance --- ARCHITECTURE_OVERVIEW.md | 35 +++++++++++++ CONTRIBUTIONS.md | 16 ++++++ v6/README.md => README.md | 107 +------------------------------------- 3 files changed, 52 insertions(+), 106 deletions(-) create mode 100644 ARCHITECTURE_OVERVIEW.md create mode 100644 CONTRIBUTIONS.md rename v6/README.md => README.md (76%) diff --git a/ARCHITECTURE_OVERVIEW.md b/ARCHITECTURE_OVERVIEW.md new file mode 100644 index 0000000..132f234 --- /dev/null +++ b/ARCHITECTURE_OVERVIEW.md @@ -0,0 +1,35 @@ +# 📁 Architecture Overview + +Frank v6 uses a **3-layer modular architecture**: + +```plaintext +Layer 1: CORE (required) +└── Frank.core.agent.md - Universal personality and base capabilities + +Layer 2: SKILLS (optional, technique-focused) +├── style.craft.instructions.md - C.R.A.F.T. framework for prompts +├── style.cot.instructions.md - Chain-of-Thought reasoning +├── style.tot.instructions.md - Tree-of-Thought reasoning +├── style.rag.instructions.md - Retrieval-Augmented Generation +├── style.advanced-reasoning.instructions.md - Overview of all techniques +├── style.markdown.instructions.md - Markdown formatting standards +└── style.mermaid.instructions.md - Diagram creation + +Layer 3: SPECIALTIES (optional, domain-focused) +├── specialty.devops.instructions.md - Docker, Ansible, IaC automation +├── specialty.prompt-engineering.instructions.md - LLM optimization +├── specialty.data-analysis.instructions.md - SQL, Python, statistics +├── specialty.sccm.instructions.md - Endpoint management (SCCM/Intune) +├── specialty.itil.instructions.md - IT service management +└── specialty.TEMPLATE.instructions.md - Create your own specialty + +Layer 4: KNOWLEDGE (reference materials) +├── example.CoT-Prompting.md - Chain-of-Thought examples +├── example.ToT-Prompting.md - Tree-of-Thought examples +├── example.RAG-Token.md - RAG examples +├── example.ReAct.md - ReAct protocol examples +├── example.ITILv4.instructions.md - ITIL framework reference +└── example.Meta-Prompting.md - Meta-prompting examples +``` + +**Key Principle**: Load only what you need. Core works alone, skills enhance reasoning, specialties add domain expertise. diff --git a/CONTRIBUTIONS.md b/CONTRIBUTIONS.md new file mode 100644 index 0000000..5a93026 --- /dev/null +++ b/CONTRIBUTIONS.md @@ -0,0 +1,16 @@ +# 🤝 Contributing + +Want to contribute a specialty or improve existing modules? + +1. **For new specialties**: Use `specialty.TEMPLATE.instructions.md` as your starting point +2. **For improvements**: Ensure changes maintain v6 compatibility +3. **For bug fixes**: Update version metadata if behavior changes +4. **Share**: Custom specialties can be shared as standalone files + +**Principles**: + +- Maintain portability (no environment coupling) +- Use relative paths +- Document in frontmatter +- Include examples in workflows +- Test with Frank.core independently diff --git a/v6/README.md b/README.md similarity index 76% rename from v6/README.md rename to README.md index 96157d2..a724e2a 100644 --- a/v6/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Frank v6 - Modular AI Assistant Framework +# Frank Meadows v6 - Modular AI Assistant Framework **Version**: 6.0 **Architecture**: Skills-Centric Modular System @@ -81,44 +81,6 @@ Load: --- -## 📁 Architecture Overview - -Frank v6 uses a **3-layer modular architecture**: - -``` -Layer 1: CORE (required) -└── Frank.core.agent.md - Universal personality and base capabilities - -Layer 2: SKILLS (optional, technique-focused) -├── style.craft.instructions.md - C.R.A.F.T. framework for prompts -├── style.cot.instructions.md - Chain-of-Thought reasoning -├── style.tot.instructions.md - Tree-of-Thought reasoning -├── style.rag.instructions.md - Retrieval-Augmented Generation -├── style.advanced-reasoning.instructions.md - Overview of all techniques -├── style.markdown.instructions.md - Markdown formatting standards -└── style.mermaid.instructions.md - Diagram creation - -Layer 3: SPECIALTIES (optional, domain-focused) -├── specialty.devops.instructions.md - Docker, Ansible, IaC automation -├── specialty.prompt-engineering.instructions.md - LLM optimization -├── specialty.data-analysis.instructions.md - SQL, Python, statistics -├── specialty.sccm.instructions.md - Endpoint management (SCCM/Intune) -├── specialty.itil.instructions.md - IT service management -└── specialty.TEMPLATE.instructions.md - Create your own specialty - -Layer 4: KNOWLEDGE (reference materials) -├── example.CoT-Prompting.md - Chain-of-Thought examples -├── example.ToT-Prompting.md - Tree-of-Thought examples -├── example.RAG-Token.md - RAG examples -├── example.ReAct.md - ReAct protocol examples -├── example.ITILv4.instructions.md - ITIL framework reference -└── example.Meta-Prompting.md - Meta-prompting examples -``` - -**Key Principle**: Load only what you need. Core works alone, skills enhance reasoning, specialties add domain expertise. - ---- - ## 🎯 Available Specialties ### DevOps & Site Reliability Engineering @@ -280,55 +242,6 @@ Want to add your own domain expertise? Use the template: --- -## 📚 Documentation - -- **[ARCHITECTURE.md](ARCHITECTURE.md)**: Comprehensive architecture guide (500+ lines) - - Design principles - - File organization - - Loading patterns - - Multi-specialty composition - - Migration from v4/v5 - - Troubleshooting - - Version history - -- **[copilot-instructions.md](copilot-instructions.md)**: VS Code integration guide - - Pre-configured loading patterns - - Quick start templates - - Multi-specialty examples - -- **Individual files**: Each skill and specialty has inline documentation - ---- - -## 🔄 Migration from Earlier Versions - -### From v5 (FrankGPT.consolidated-instructions.md) - -**v5 approach**: Single monolithic file with all capabilities -**v6 approach**: Modular - load only what you need - -**Migration path**: -1. **Core functionality**: Use `Frank.core.agent.md` (replaces universal personas) -2. **IT operations**: Use `specialty.itil.instructions.md` (replaces ITIL/incident workflows) -3. **DevOps**: Use `specialty.devops.instructions.md` (replaces Docker/Ansible sections) -4. **Prompting**: Use `specialty.prompt-engineering.instructions.md` (replaces prompt optimization) - -**Benefit**: Smaller context window, faster loading, compose only what you need - -### From v4 (Multiple agents/ files) - -**v4 approach**: Separate agent files (Data Analyst, SCCM Tutor, etc.) -**v6 approach**: Specialties that compose with shared core - -**Migration path**: -- `agents/Data Analyst.agent.md` → `specialty.data-analysis.instructions.md` -- `agents/SCCM Tutor.agent.md` → `specialty.sccm.instructions.md` -- Custom agents → Create using `specialty.TEMPLATE.instructions.md` - -**Benefit**: Shared core personality, multi-specialty composition, portable structure - ---- - ## 🏗️ Design Principles ### 1. Portability First @@ -438,24 +351,6 @@ Load: Frank.core.agent.md --- -## 🤝 Contributing - -Want to contribute a specialty or improve existing modules? - -1. **For new specialties**: Use `specialty.TEMPLATE.instructions.md` as your starting point -2. **For improvements**: Ensure changes maintain v6 compatibility -3. **For bug fixes**: Update version metadata if behavior changes -4. **Share**: Custom specialties can be shared as standalone files - -**Principles**: -- Maintain portability (no environment coupling) -- Use relative paths -- Document in frontmatter -- Include examples in workflows -- Test with Frank.core independently - ---- - ## 📜 Version History ### v6.0 (April 2026)