From c034e9f2eed0ea9aee913b89ec13c64ce487b387 Mon Sep 17 00:00:00 2001 From: Enrico Ros Date: Sun, 2 Feb 2025 09:48:23 -0800 Subject: [PATCH] Link FAQs --- docs/README.md | 45 ++++++++++++++++++++++++++------------------- 1 file changed, 26 insertions(+), 19 deletions(-) diff --git a/docs/README.md b/docs/README.md index f0456b99c..57f8b7827 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,31 +4,39 @@ Information you need to get started, configure, and use big-AGI productively. ## Getting Started -Guides for basic big-AGI features: +Essential guides: -- **[Enabling Microphone for Speech Recognition](help-feature-microphone.md)**: Instructions to - allow speech recognition in browsers and apps. +- **[FAQ](help-faq.md)**: Common questions and answers +- **[Enabling Microphone](help-feature-microphone.md)**: Configure speech recognition in your browser -## AI Model Configuration +## AI Services -Detailed guides to configure AI models and advanced features in big-AGI. +How to set up AI models and features in big-AGI. > 👉 The following applies to users of big-AGI.com, as the public instance is empty and requires user configuration. - **Cloud AI Services**: - - **[Azure OpenAI](config-azure-openai.md)** - - **[OpenRouter](config-openrouter.md)** - - Easy API key setup: **Anthropic**, **Deepseek**, **Google AI**, **Groq**, **Mistral**, **OpenAI**, **OpenPipe**, **Perplexity**, **TogetherAI**, **xAI** + - Easy API key configuration: + [Anthropic](https://console.anthropic.com/settings/keys), + [Deepseek](https://platform.deepseek.com/api_keys), + [Google Gemini](https://aistudio.google.com/app/apikey), + [Groq](https://console.groq.com/keys), + [Mistral](https://console.mistral.ai/api-keys/), + [OpenAI](https://platform.openai.com/api-keys), + [OpenPipe](https://app.openpipe.ai/settings), + [Perplexity](https://www.perplexity.ai/settings/api), + [TogetherAI](https://api.together.xyz/settings/api-keys), + [xAI](http://x.ai/api) + - **[Azure OpenAI](config-azure-openai.md)** guide + - **[OpenRouter](config-openrouter.md)** guide - **Local AI Integrations**: - - **[LocalAI](config-local-localai.md)** - - **[LM Studio](config-local-lmstudio.md)** - - **[Ollama](config-local-ollama.md)** + - [LocalAI](config-local-localai.md), [LM Studio](config-local-lmstudio.md), [Ollama](config-local-ollama.md) - **Enhanced AI Features**: - - **[Web Browsing](config-feature-browse.md)**: Enable web page download through third-party services or your own cloud (advanced) + - **[Web Browsing](config-feature-browse.md)**: Enable web page download through third-party services or your own cloud - **Web Search**: Google Search API (see '[Environment Variables](environment-variables.md)') - **Image Generation**: DALL·E 3 and 2, or Prodia API for Stable Diffusion XL - **Voice Synthesis**: ElevenLabs API for voice generation @@ -39,13 +47,14 @@ Detailed guides to configure AI models and advanced features in big-AGI. For deploying a custom big-AGI instance: -- **[Installation Guide](installation.md)**: Set up your own big-AGI instance +- **[Installation Guide](installation.md)**, including: + - Set up your own big-AGI instance - Source build or pre-built options - Local, cloud, or on-premises deployment - **Advanced Setup**: - - **[Source Code Customization Guide](customizations.md)**: Modify the source code + - **[Source Code Customization](customizations.md)**: Modify the source code - **[Access Control](deploy-authentication.md)**: Optional, add basic user authentication - **[Database Setup](deploy-database.md)**: Optional, enables "Chat Link Sharing" - **[Reverse Proxy](deploy-reverse-proxy.md)**: Optional, enables custom domains and SSL @@ -53,10 +62,8 @@ For deploying a custom big-AGI instance: ## Community & Support -Connect with the growing big-AGI community: - - Visit our [GitHub repository](https://github.com/enricoros/big-AGI) for source code and issue tracking -- Check the latest updates and features on [Changelog](changelog.md) or the in-app [News](https://get.big-agi.com/news) -- Connect with us and other users on [Discord](https://discord.gg/MkH4qj2Jp9) for discussions, help, and sharing your experiences with big-AGI +- Check the latest updates in the [Changelog](changelog.md) or in-app [News](https://get.big-agi.com/news) +- Join our [Discord](https://discord.gg/MkH4qj2Jp9) for discussions and help -Thank you for choosing big-AGI. We're excited to give you the best tools to amplify yourself. +Let's build something great.