diff --git a/README.md b/README.md index 7d7ed62..a3e145e 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # AI Coding Playbook -Portable, engineering-first prompts and execution contracts for interactive AI coding and autonomous engineering workflows. +An **experimental personal side project** exploring how AI coding agents can improve everyday software engineering work. The prompts, workflows, and tools here are learning experiments—not production-ready guarantees. ## About -A tool-neutral toolkit for scoped AI-assisted development, structured tasks, independent verification, and human-reviewed delivery. It supports Codex, Claude Code, Cursor, GitHub Copilot, and Gemini CLI through documented assistant entrypoints. +A tool-neutral experimental toolkit for scoped AI-assisted development, structured tasks, independent verification, and human-reviewed delivery. It supports Codex, Claude Code, Cursor, GitHub Copilot, and Gemini CLI through documented assistant entrypoints. **[Documentation](docs/README.md)** · [Practical usage guide](docs/USAGE_GUIDE.md) · [Getting started](docs/GETTING_STARTED.md) · [CLI reference](docs/CLI.md) · [Adopt in an existing repository](docs/ADOPTION.md) · [Prompt catalog](prompts/README.md) · [Contributing](CONTRIBUTING.md) diff --git a/docs/GETTING_STARTED.md b/docs/GETTING_STARTED.md index ada40e6..1d5600c 100644 --- a/docs/GETTING_STARTED.md +++ b/docs/GETTING_STARTED.md @@ -1,5 +1,8 @@ # Getting started +**Before you begin:** AI Coding Playbook is an experimental personal side project for exploring AI agents in everyday development workflows. The tooling and examples are for experimentation and learning, not production-ready automation. Review all generated changes and run it only in environments appropriate for experimentation. + + ## Optional CLI installation From a playbook checkout with Python 3.10+, run `python3 -m pip install -e .` (preferably inside a virtual environment). This installs the `aicp` command so you can run `aicp --help`, `aicp init`, and `aicp verify` from other working directories. Installation does not install or authenticate any vendor coding assistant. The checkout-based `python3 -m aicp` commands below remain supported. This project is not yet published to a package index. diff --git a/docs/README.md b/docs/README.md index 8d65d49..2602efe 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,5 +1,8 @@ # Documentation +> **Project status:** This is an experimental personal side project for learning and testing ways to make everyday software engineering work more effective with AI agents. It is not a production-grade framework or an endorsement by any employer or organization. Evaluate its limitations and use your own judgment before applying it to real projects. + + Start with [Getting started](GETTING_STARTED.md) for quick setup, the [practical walkthrough](PRACTICAL_WALKTHROUGH.md) for a supervised end-to-end example, or the [usage guide](USAGE_GUIDE.md) for additional fictional workflows and privacy guidance. - [Runnable practical example: synthetic Python service](../examples/practical/README.md)