Skip to content

docs: clarify experimental personal side-project purpose #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ipolyzos merged 3 commits into from
Oct 10, 2026
Merged

docs: clarify experimental personal side-project purpose #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d3f4cdf
docs: clarify personal experimental purpose and limitations
ipolyzos Oct 10, 2026
aaa74f1
docs: clarify personal experimental purpose and limitations
ipolyzos Oct 10, 2026
37a78f5
docs: clarify personal experimental purpose and limitations
ipolyzos Oct 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)

Expand Down
3 changes: 3 additions & 0 deletions docs/GETTING_STARTED.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
3 changes: 3 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
Loading