- Add setup-wizard.sh for interactive configuration
- Add docker-compose.swarm.yml optimized for swarm deployment
- Make CLAUDE_API_KEY optional based on AI_PROVIDER setting
- Support multiple AI providers: Ollama, Claude API, OpenAI
- Add BETTER_AUTH_SECRET to .env.example
- Update deploy-swarm.sh to validate AI provider config
- Add comprehensive documentation (DOCKER-SWARM.md, SWARM-QUICKREF.md)
Changes:
- AI_PROVIDER env var controls which AI backend to use
- Ollama is default (no API key required)
- Claude API and OpenAI require respective API keys
- Deployment script validates based on selected provider
- Removed Authentik services from swarm compose (using external)
- Configured for upstream Traefik integration
- Created KNOWLEDGE_USER_GUIDE.md with comprehensive user documentation
- Getting started, creating entries, wiki-links
- Tags and organization, search capabilities
- Import/export, version history, graph visualization
- Tips, best practices, and permissions
- Created KNOWLEDGE_API.md with complete REST API reference
- All endpoints with request/response formats
- Authentication and permissions
- Detailed examples with curl and JavaScript
- Error responses and validation
- Created KNOWLEDGE_DEV.md with developer documentation
- Architecture overview and module structure
- Database schema with all models
- Service layer implementation details
- Caching strategy and performance
- Wiki-link parsing and resolution system
- Testing guide and contribution guidelines
- Updated README.md with Knowledge Module section
- Feature overview and quick examples
- Links to detailed documentation
- Performance metrics
- Added knowledge management to overview
All documentation includes:
- Real examples from codebase
- Code snippets and API calls
- Best practices and workflows
- Cross-references between docs
- Organized docs into numbered shelf/book/chapter/page structure
- Created comprehensive README.md with project overview
- Added Getting Started book (quick start, installation, configuration)
- Added Development book (workflow, testing, type sharing)
- Added Architecture book (design principles, PDA-friendly patterns)
- Added API Reference book (conventions, authentication)
- Moved TYPE-SHARING.md to proper location
- Updated all cross-references in main README
- Created docs/README.md as master index
- Removed old QA automation reports
- Removed deprecated SETUP.md (content split into new structure)
Documentation structure follows Bookstack best practices:
- Numbered books: 1-getting-started, 2-development, 3-architecture, 4-api
- Numbered chapters and pages for ordering
- Clear hierarchy and navigation
- Cross-referenced throughout
Complete documentation available at: docs/README.md
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
