promptitecture

Documentation

Welcome to the PrompTitecture documentation!

Structure

• architecture/ - Architecture diagrams and specifications
• guides/ - User guides and tutorials
• api/ - API reference documentation

Quick Links

• Main README
• Architecture Guide
• API Reference
• User Guides

Contributing to Documentation

To contribute to the documentation:

1. Follow the existing structure
2. Use clear, concise language
3. Include code examples where applicable
4. Keep diagrams updated
5. Test all links

Building Documentation

The documentation is automatically built and deployed to GitHub Pages from the docs/ directory.

For local preview:

# Install dependencies
pip install mkdocs mkdocs-material

# Serve locally
mkdocs serve

License

This documentation is licensed under the MIT License - see the LICENSE file for details.