Update documentation for first-time users and fix outdated agent names
Major documentation improvements: - Fixed all outdated agent names throughout README.md and GETTING_STARTED.md - Updated agent references from old names (todo-keeper, changelog-keeper, setup-repository) to new names (keepaTodofile, keepaChangelog, setupRepository) - Created comprehensive HELLO_WORLD_TUTORIAL.md with step-by-step guide for new users - Added prominent tutorial links in README.md and GETTING_STARTED.md for better discoverability - Updated Python version requirements from 3.8 to 3.9 in project templates - Enhanced first-time user experience with clear guidance and working examples Documentation now provides: ✅ Working commands that match actual agent names ✅ Clear separation between new users and experienced users ✅ Complete tutorial from installation to running code ✅ Proper guidance for scenario one (greenfield projects) 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
@@ -2,6 +2,8 @@
|
||||
|
||||
This guide walks you through using Kaizen Agentic agents in any project, from initial installation to full integration.
|
||||
|
||||
> **👋 New User?** Start with our [Hello World Tutorial](HELLO_WORLD_TUTORIAL.md) for a complete step-by-step walkthrough.
|
||||
|
||||
## Quick Start
|
||||
|
||||
### 1. Install the Package
|
||||
@@ -50,9 +52,9 @@ cd my-project
|
||||
git init
|
||||
|
||||
# Install agents
|
||||
kaizen-agentic install setup-repository todo-keeper changelog-keeper
|
||||
kaizen-agentic install setupRepository keepaTodofile keepaChangelog
|
||||
|
||||
# The setup-repository agent can create the full project structure
|
||||
# The setupRepository agent can create the full project structure
|
||||
# Use it via Claude Code or manually follow its patterns
|
||||
```
|
||||
|
||||
@@ -65,7 +67,7 @@ kaizen-agentic install setup-repository todo-keeper changelog-keeper
|
||||
cd /path/to/your/project
|
||||
|
||||
# Install relevant agents
|
||||
kaizen-agentic install todo-keeper changelog-keeper tdd-workflow
|
||||
kaizen-agentic install keepaTodofile keepaChangelog tdd-workflow
|
||||
|
||||
# Check what was installed
|
||||
kaizen-agentic status
|
||||
@@ -224,7 +226,7 @@ alias ka-list="kaizen-agentic list"
|
||||
# Now you can use:
|
||||
# ka status
|
||||
# ka update
|
||||
# ka install todo-keeper
|
||||
# ka install keepaTodofile
|
||||
```
|
||||
|
||||
## Language-Specific Integration
|
||||
@@ -295,7 +297,7 @@ kaizen-agentic status
|
||||
|
||||
# Read agent files directly
|
||||
ls agents/
|
||||
cat agents/agent-todo-keeper.md
|
||||
cat agents/agent-keepaTodofile.md
|
||||
|
||||
# Validate your setup
|
||||
kaizen-agentic validate
|
||||
@@ -374,10 +376,10 @@ pip install kaizen-agentic
|
||||
**"No agents directory found"**
|
||||
```bash
|
||||
# Install some agents first
|
||||
kaizen-agentic install todo-keeper
|
||||
kaizen-agentic install keepaTodofile
|
||||
|
||||
# Or initialize a new project
|
||||
kaizen-agentic init . --agents todo-keeper,changelog-keeper
|
||||
kaizen-agentic init . --agents keepaTodofile,keepaChangelog
|
||||
```
|
||||
|
||||
**"Agent validation fails"**
|
||||
|
||||
Reference in New Issue
Block a user