feat: update readme and documentation #1962
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add Moonshot AI (Kimi) provider documentation with setup guide - Update xAI Grok models with latest versions (Grok 4, Grok 3 variants) - Fix anchor links in table of contents for Git integration and WebContainer - Completely rewrite 'Adding New LLMs' section with correct provider architecture - Update FAQ with latest model recommendations and troubleshooting - Add API key configuration examples for new providers - Enhance model comparisons with current capabilities and context windows - Add comprehensive best practices for all new features - Document MCP integration, deployment options, and Supabase features - Update project templates section with all available frameworks This brings the documentation fully up-to-date with the latest main branch changes and provides users with accurate, comprehensive information about all bolt.diy features.
- Add HelpButton component with question mark icon - Integrate help button into sidebar next to settings button - Link opens documentation in new tab when clicked - Maintain consistent styling with existing sidebar buttons - Improve user accessibility to documentation resources
- Document new help icon in sidebar functionality - Add getting help section to main documentation - Include help icon in FAQ section - Update tips and tricks to mention help icon - Provide comprehensive help resources overview
- Update supported providers list with 19+ providers including Cohere, Together, Perplexity, Moonshot, Hyperbolic, GitHub Models, Amazon Bedrock - Fix typos and improve grammar throughout documentation - Replace 'Requested Additions' with modern 'Recent Major Additions' section - Add comprehensive desktop app installation instructions - Completely rewrite API keys and providers configuration section to match new UI - Add detailed available scripts including Docker and Electron commands - Enhance features section with new capabilities - Add troubleshooting section for common configuration issues
- Update provider count from '20+' to '19' to match actual implementation - Update API key configuration instructions to reflect new modern UI - Update provider navigation paths to match current interface - Fix Moonshot provider configuration path - Ensure all documentation accurately reflects current codebase state
…ility - Moved help icon from bottom of sidebar to header area next to user profile - Improved UX by placing help in more visible and logical location - Follows common UI patterns where help/support is in header area - Increases discoverability for new users
- Added Help & Documentation option to user avatar dropdown in console dashboard - Provides easy access to documentation from any page in the application - Maintains consistent styling with other dropdown menu items - Uses same help icon and links to official documentation - Improves user experience by providing help access from main dashboard area
- Removed Service Status menu item as it's being deprecated - Cleaned up unused BetaLabel component - Maintains clean dropdown structure with remaining items - Prepares for upcoming Service Status removal in separate PR
- Clean up formatting from linting process - Remove unnecessary blank line after imports
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📚 Documentation Updates - Complete Synchronization
Overview
This PR brings all documentation files completely up-to-date with the current codebase implementation, ensuring users have accurate and comprehensive information about bolt.diy's features and setup process.
🔄 Changes Made
1. Provider Count Corrections
README.md,docs/docs/index.md,docs/docs/FAQ.md/app/lib/modules/llm/providers/2. API Configuration UI Updates
README.md,docs/docs/index.md,docs/docs/FAQ.md3. Feature Documentation Expansion
4. Script Documentation Updates
pnpm run dev,pnpm run build,pnpm run previewpnpm test,pnpm run test:watch,pnpm run lintpnpm run dockerbuild,pnpm run dockerbuild:prod,pnpm run dockerrunpnpm run deploy(Cloudflare Pages)5. Installation Instructions Enhancement
6. Navigation & Structure Improvements
🔍 Verification & Quality Assurance
Implementation Verification
/app/lib/modules/llm/providers/)package.json/app/routes/api/)Quality Checks
Documentation Coverage
📊 Files Modified
README.mddocs/docs/index.mddocs/docs/FAQ.mddocs/docs/CONTRIBUTING.md🎯 Impact
For Users
For Developers
🔗 Related Commits
23c0a8a- docs: update index.md and FAQ.md documentationa06161a- docs: fix table of contents to match updated section names118e687- docs: merge updated README from BOLTDIY_documentation branch79abddd- Merge remote-tracking branch 'origin/BOLTDIY_documentation'✅ Testing
This PR ensures complete documentation-codebase synchronization, providing users with accurate, comprehensive, and up-to-date information about bolt.diy's capabilities and setup process. 🚀