From fdaf51f0ea5d2f324137dfe83224a30171b8aa33 Mon Sep 17 00:00:00 2001 From: Debanjum Date: Fri, 18 Apr 2025 22:39:27 +0530 Subject: [PATCH] Fix formatting in readme and documentation --- README.md | 6 +++--- documentation/docs/advanced/gcp-vertex.md | 10 +++++----- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 6887fe71..e21bd0dc 100644 --- a/README.md +++ b/README.md @@ -73,13 +73,13 @@ Khoj is available as a cloud service, on-premises, or as a hybrid solution. To l ## Frequently Asked Questions (FAQ) -Q: Can I use Khoj without self-hosting? +Q: Can I use Khoj without self-hosting? Yes! You can use Khoj right away at [https://app.khoj.dev](https://app.khoj.dev) — no setup required. -Q: What kinds of documents can Khoj read? +Q: What kinds of documents can Khoj read? Khoj supports a wide variety: PDFs, Markdown, Notion, Word docs, org-mode files, and more. -Q: How can I make my own agent? +Q: How can I make my own agent? Check out [this blog post](https://blog.khoj.dev/posts/create-agents-on-khoj/) for a step-by-step guide to custom agents. For more questions, head over to our [Discord](https://discord.gg/BDgyabRM6e)! diff --git a/documentation/docs/advanced/gcp-vertex.md b/documentation/docs/advanced/gcp-vertex.md index da9ac771..6801aed9 100644 --- a/documentation/docs/advanced/gcp-vertex.md +++ b/documentation/docs/advanced/gcp-vertex.md @@ -27,19 +27,19 @@ Khoj can use Google's Gemini and Anthropic's Claude family of AI models from [Ve ## Troubleshooting & gcp AI Tips -- Permission Denied? +- Permission Denied? Ensure your service account has the `Vertex AI User` role and that the API is enabled in your GCP project. -- Region Errors? +- Region Errors? Double-check that the model you're trying to use is supported in your selected region. Some Claude or Gemini models are restricted to specific zones like `us-east5` or `us-central1`. -- Prompt Size Limitations +- Prompt Size Limitations The "Max prompt size" should align with the limits defined in the model documentation. Exceeding it can silently fail or truncate inputs. -- Testing the API Key +- Testing the API Key Before adding it to Khoj, you can verify that your key works by making a simple curl request to Vertex AI. This helps debug auth issues early. -- Use Environment Variables +- Use Environment Variables For better security, consider using environment variables to manage sensitive keys and inject them at runtime during base64 encoding. If you encounter any issues, the [Khoj Discord](https://discord.gg/BDgyabRM6e) is a great place to ask for help!