This repository was archived by the owner on Jan 31, 2025. It is now read-only.
File tree Expand file tree Collapse file tree 2 files changed +25421
-9
lines changed Expand file tree Collapse file tree 2 files changed +25421
-9
lines changed Original file line number Diff line number Diff line change @@ -39,20 +39,28 @@ npm run test
3939npm run build
4040```
4141
42- ### AI Chat
42+ ## llms.txt
4343
44- To get AI chat working when running docs locally, you need to create
45- ` .env.local ` file in this directory with a ` CONVEX_URL ` environment variable:
44+ This is a file that was manually generated using Firecrawl:
45+ https://www.firecrawl.dev/blog/How-to-Create-an-llms-txt-File-for-Any-Website
4646
47- ``` yaml
48- CONVEX_URL="https://fantastic-otter-933.convex.cloud" # team: convex, project: ai-bot
49- ```
47+ You need to get an API key from Firecrawl and follow the instructions on that
48+ blog post above.
49+
50+ I then did a few manual edits:
51+
52+ - Removed all Google Analytics references (simple regex find and replace)
53+ - Put the home page text at the top
54+ - Cleaned up youtube embeds output they were pretty messy.
5055
51- #### Using your own AI Chat deployment
56+ Otherwise it generated reasonably decent output. We should eventually make this
57+ more automated with every publish.
5258
53- Follow the README in ` npm-packages/convex-ai-chat ` .
59+ See
60+ [ here] ( https://linear.app/convex/issue/DX-1412/create-an-llmstxt-file-for-the-website-and-docs-page ) .
61+ For the full background.
5462
55- ### Spell-checking in VS Code
63+ ## Spell-checking in VS Code
5664
5765You can enable spell checking in VS Code by installing
5866[ Code Spell Checker] ( https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker ) .
You can’t perform that action at this time.
0 commit comments