|
| 1 | +# CRAFT Tutorial Project (/tutorial) |
| 2 | + |
| 3 | +Welcome to the beginner's tutorial for CRAFT — Configurable Reusable AI Framework Technology. |
| 4 | + |
| 5 | +## 1) What it is |
| 6 | + |
| 7 | +This `/tutorial` folder contains the official CRAFT Tutorial Project designed for absolute beginners. It demonstrates CRAFT's four-file architecture through an interactive, self-guided learning experience with AutoStart functionality that activates whenever you mention CRAFT to your AI assistant. See the repo's `core/` for the framework files that power this tutorial. |
| 8 | + |
| 9 | +## 2) Why it's useful |
| 10 | + |
| 11 | +The CRAFT Tutorial helps newcomers understand structured AI workflows through: |
| 12 | + |
| 13 | +- **AutoStart activation** that begins automatically when you mention CRAFT. |
| 14 | +- **Adaptive learning paths** with Quick Start (3 features) or Standard (5 features at a time) options. |
| 15 | +- **Context-aware help system** activated anytime with "HELP" command. |
| 16 | +- **Progress tracking** that remembers what you've learned across sessions via handoffs. |
| 17 | +- **Beginner-friendly explanations** assuming zero prior CRAFT knowledge. |
| 18 | + |
| 19 | +## 3) Install / Quick Start |
| 20 | + |
| 21 | +No build step required — CRAFT runs through Python-compatible text files you share with your AI assistant. |
| 22 | + |
| 23 | +1. **Clone / open the repo** and review its layout: |
| 24 | + ``` |
| 25 | + core/ # Framework spec & cookbook (CRAFT core) |
| 26 | + tutorial/ # You are here (tutorial project files) |
| 27 | + docs/ # Documentation hub |
| 28 | + examples/ # Additional sample projects |
| 29 | + .github/ # Issue/PR templates, workflows, config |
| 30 | + ``` |
| 31 | + |
| 32 | +2. **Load the four CRAFT tutorial files** with your AI assistant: |
| 33 | + - `CFT-FWK-SPEC-v*.txt` – Framework Specification (CRAFT rules & patterns) |
| 34 | + - `CFT-FWK-COOKBK-CORE-v*.txt` – Core Cookbook (base recipes) |
| 35 | + - `CFT-PROJ-TUT-001_CRAFT-TUTORIAL-BASICS-v*.txt` – Tutorial Project Implementation |
| 36 | + - `CFT-PROJ-TUT-001_AI-CHAT-HISTORY-v*.txt` – Tutorial Chat Handoff file |
| 37 | + |
| 38 | +3. **Start learning** by simply mentioning CRAFT to your AI: |
| 39 | + - Say something like "Let's use CRAFT" or "Initialize CRAFT" |
| 40 | + - The AutoStart feature will detect this and initialize the tutorial |
| 41 | + - Choose Quick Start (5 minutes) or Standard Tutorial (10 minutes) |
| 42 | + |
| 43 | +4. **Use the help system** whenever you need: |
| 44 | + - Type "HELP" at any point for context-aware assistance |
| 45 | + - Say "start tutorial" to begin or resume the tutorial |
| 46 | + - Progress is tracked automatically between sessions |
| 47 | + |
| 48 | +5. **Review handoff H001** in the Chat History file to see: |
| 49 | + - Tutorial structure and learning paths |
| 50 | + - Key decisions about tutorial design |
| 51 | + - Next steps for your learning journey |
| 52 | + |
| 53 | +**Tip:** Start with the Quick Start mode to learn the three essential CRAFT features (Comment System, Recipe Basics, Project Structure), then explore deeper with the Standard Tutorial. |
| 54 | + |
| 55 | +## 4) Links to docs/ |
| 56 | + |
| 57 | +- **Getting Started** → `../docs/getting-started.md` |
| 58 | +- **Framework Overview** (four-file model & roles) → `../docs/framework-overview.md` |
| 59 | +- **CRAFT Comment System** (H->AI / AI->H patterns) → `../docs/comment-system.md` |
| 60 | +- **Project File Guide** → `../docs/project-file.md` |
| 61 | +- **Chat Handoff Guide** → `../docs/handoff-guide.md` |
| 62 | +- **Core Cookbook Guide** → `../docs/cookbook-core.md` |
| 63 | +- **Framework Spec Reference** → `../docs/framework-spec-reference.md` |
| 64 | +- **Examples Index** → `../examples/README.md` |
| 65 | +- **Core Index** → `../core/README.md` |
| 66 | + |
| 67 | +## 5) Tutorial Features |
| 68 | + |
| 69 | +### AutoStart System |
| 70 | +- Monitors for ANY mention of "CRAFT" in initial prompts |
| 71 | +- Automatically executes `CHAT_SESSION_INITIALIZATION_RECIPE` |
| 72 | +- Provides clear feedback: "CRAFT Tutorial System detected! Initializing..." |
| 73 | + |
| 74 | +### Learning Modes |
| 75 | +1. **Quick Start Mode** (3 essential features, ~5 minutes) |
| 76 | + - Comment System basics |
| 77 | + - Recipe fundamentals |
| 78 | + - Project file structure |
| 79 | + |
| 80 | +2. **Standard Mode** (5 features at a time, ~10 minutes) |
| 81 | + - Adaptive selection based on your needs |
| 82 | + - Examples and practice for each feature |
| 83 | + - Progress tracking between sessions |
| 84 | + |
| 85 | +3. **Help Mode** (always available) |
| 86 | + - Context-aware assistance |
| 87 | + - Menu of common topics |
| 88 | + - Responds to "HELP" in any variation |
| 89 | + |
| 90 | +### Core Features Covered |
| 91 | +- Comment System (H->AI and AI->H) |
| 92 | +- Recipe System |
| 93 | +- Project Structure (4 files) |
| 94 | +- Handoff System |
| 95 | +- CRAFT-OPERATIONS-MANAGER (COM) |
| 96 | +- Personas and Roles |
| 97 | +- Global Instructions |
| 98 | +- Project Variables |
| 99 | +- Security Protocols |
| 100 | +- Token Management |
| 101 | +- Artifact Creation |
| 102 | +- Framework Specification |
| 103 | +- Cookbook Recipes |
| 104 | +- Session Initialization |
| 105 | +- Content Type Detection |
| 106 | + |
| 107 | +## 6) How to contribute |
| 108 | + |
| 109 | +1. **Read** `CONTRIBUTING.md` and `CODE_OF_CONDUCT.md` at the repo root. |
| 110 | +2. **For tutorial improvements**, create a branch and edit files under `/tutorial`. |
| 111 | +3. **Test changes** with actual beginners to ensure clarity. |
| 112 | +4. **Open an Issue** for proposals; link it in your PR. |
| 113 | +5. **Follow style**: patient explanations, zero assumed knowledge, practical examples. |
| 114 | +6. **Keep synced** with core framework updates and best practices. |
| 115 | + |
| 116 | +## 7) License |
| 117 | + |
| 118 | +This repository uses the **Business Source License 1.1 (BSL 1.1)**. |
| 119 | + |
| 120 | +- **Non-commercial use** (research, educational, experimental) is permitted. |
| 121 | +- **Commercial use** requires a separate license from Ketelsen Digital Solutions LLC. |
| 122 | +- **On or after 2029-01-01**, applicable files are set to relicense to Apache 2.0. |
| 123 | + |
| 124 | +See the root `LICENSE` for the full legal text. For commercial use, please contact Ketelsen Digital Solutions LLC to obtain a commercial license. |
| 125 | + |
| 126 | +## 8) Alpha Software Notice |
| 127 | + |
| 128 | +⚠️ **IMPORTANT:** CRAFT is currently in ALPHA phase. This tutorial reflects the current state as of August 2025. Features, syntax, and functionality may evolve. The tutorial focuses on stable, core features that are fundamental to CRAFT's design. |
| 129 | + |
| 130 | +--- |
| 131 | + |
| 132 | +**Ready to start?** Load the tutorial files with your AI assistant and say "Let's use CRAFT" to begin your journey! |
0 commit comments