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:
2025-10-19 09:13:50 +02:00
parent d560d1dcfd
commit ca6909a04f
4 changed files with 294 additions and 19 deletions

View File

@@ -11,7 +11,10 @@ This project embraces the Japanese concept of "kaizen" (continuous improvement)
pip install kaizen-agentic
```
### Initialize a New Project
### Your First Project (New Users)
**👋 New to Kaizen Agentic?** Follow our [Hello World Tutorial](docs/HELLO_WORLD_TUTORIAL.md) for a complete step-by-step guide.
### Create a Project (Experienced Users)
```bash
# Create a new project with AI agents
kaizen-agentic init my-project --template python-web
@@ -30,7 +33,7 @@ make help # See all available commands
cd your-existing-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
@@ -48,10 +51,10 @@ kaizen-agentic status
## Available Agents
### Project Management
- **todo-keeper**: Manages TODO.md files following Keep a Todofile format
- **changelog-keeper**: Maintains CHANGELOG.md files following Keep a Changelog format
- **contributing-keeper**: Creates and updates CONTRIBUTING.md files
- **project-assistant**: General project management and coordination
- **keepaTodofile**: Manages TODO.md files following Keep a Todofile format
- **keepaChangelog**: Maintains CHANGELOG.md files following Keep a Changelog format
- **keepaContributingfile**: Creates and updates CONTRIBUTING.md files
- **project-management**: General project management and coordination
### Development Process
- **tdd-workflow**: Test-driven development workflow guidance
@@ -60,13 +63,13 @@ kaizen-agentic status
### Code Quality
- **code-refactoring**: Code improvement and refactoring guidance
- **agent-optimization**: Agent definition optimization and improvement
- **optimization**: Agent definition optimization and improvement
- **datamodel-optimization**: Data model design and optimization
### Infrastructure
- **setup-repository**: Repository initialization and standards compliance
- **setupRepository**: Repository initialization and standards compliance
- **claude-documentation**: Claude Code configuration and documentation
- **testing-efficiency**: Testing infrastructure optimization
- **tooling-optimization**: Repository tooling usage optimization
[View complete agent list](docs/AGENT_DISTRIBUTION.md#agent-categories)