Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

README.md

🤖 AI Persona Builder Documentation

Welcome to the official documentation for the AI Persona Builder. This documentation is structured to guide you based on your goals, whether you're a new user, a module author, or a contributor to the project.

🚀 1. Getting Started

Audience: New Users

If you're new to the project, start here. This section provides the fastest path to installing the CLI, understanding the core concepts, and building your first AI persona in minutes.

📖 2. User Guide

Audience: Regular Users

Dive deeper into the system's features and philosophy. This section is for users who want to move beyond the basics and master the tool.

  • **01-core-concepts.md**: A crucial document explaining the vision, the four-tier architecture, and the core principles of the system.
  • **02-cli-reference.md**: A complete and detailed reference for every command, argument, and option available in the CLI.
  • **03-faq.md**: Answers to frequently asked questions about design, usage, and best practices.

✍️ 3. Authoring

Audience: Module & Persona Authors

This section is for those who want to create their own high-quality, effective modules and personas. It contains the official standards, examples, and advanced patterns.

🤝 4. Contributing

Audience: Project Contributors

For developers who want to contribute to the AI Persona Builder CLI tool itself. This section contains information on our governance, codebase architecture, and testing strategy.

🔬 5. Case Studies

Audience: All Users

Explore real-world examples of how the AI Persona Builder is used to solve complex problems and improve AI reliability.

🗄️ Archive

For historical reference, older documents that have been superseded or are no longer relevant to the current state of the project are stored in the archive directory.