soulcraft/brainy
2
0
Fork 0
Code Issues 1 Pull requests Projects Releases 335 Packages Wiki Activity Actions

docs: Update documentation index for 1.0 and create comprehensive CLI 1.0 reference

Browse source 
- Update docs/README.md to prioritize Brainy 1.0 Quick Start guide
- Add 1.0 migration guide and changelog to recently updated section
- Create comprehensive brainy-cli-1.0.md reference guide:
  - Document all 9 unified CLI commands (down from 40+)
  - Show before/after comparison of command simplification
  - Cover smart defaults, encryption, neural import, chat mode
  - Include migration guide from 0.x CLI commands
  - Add production deployment examples and performance tips
- Ready for users to discover and use the new unified CLI experience
This commit is contained in:
David Snelling 2025-08-14 12:13:10 -07:00
parent 180619defa
commit a1d6754a21
2 changed files with 344 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/README.md
View file

@ -7,7 +7,8 @@ Welcome to the comprehensive documentation for Brainy - the intelligent vector g
### 🚀 [Getting Started](getting-started/)
Quick setup guides and first steps with Brainy.
- **[Quick Start Guide](getting-started/quick-start.md)** - Get up and running in minutes
- **[Brainy 1.0 Quick Start](getting-started/quick-start-1.0.md)** - Get up and running with the unified API ⭐
- **[Legacy Quick Start (0.x)](getting-started/quick-start.md)** - For existing 0.x users
- **[Installation Guide](getting-started/installation.md)** - Installation options and requirements
- **[Environment Setup](getting-started/environment-setup.md)** - Configure your development environment
- **[First Steps](getting-started/first-steps.md)** - Your first Brainy application
@ -104,12 +105,13 @@ Common issues and solutions.
2. **[Documentation Standards](development/DOCUMENTATION_STANDARDS.md)** - Writing docs
3. **[Testing Guide](development/testing.md)** - Testing practices
## 🔄 Recently Updated
## 🔄 Recently Updated (Brainy 1.0)
- **[S3 Migration Guide](optimization-guides/s3-migration-guide.md)** - NEW: Complete migration guide for shared S3 buckets
- **[Brainy 1.0 Quick Start](getting-started/quick-start-1.0.md)** - NEW: Unified API with 7 core methods ⭐
- **[Migration Guide](../MIGRATION.md)** - NEW: Complete 0.x to 1.0 upgrade guide
- **[Changelog](../CHANGELOG.md)** - NEW: 1.0 release candidate details
- **[S3 Migration Guide](optimization-guides/s3-migration-guide.md)** - Complete migration guide for shared S3 buckets
- **[Large-Scale Optimizations](optimization-guides/large-scale-optimizations.md)** - Complete rewrite with auto-configuration
- **[Quick Start Guide](getting-started/quick-start.md)** - Updated with zero-config setup
- **[API Reference](api-reference/)** - New auto-configuration APIs
## 📞 Getting Help