Out of Date Docs / Stack Links
Hey guys, im just working on a little project for https://hackathon.webdevcody.com/ and noticed that there are quite a lot of broken links and bad information in the docs for convex.
It makes it really hard for new people to come in and understand why things arent working.
I suggest going through all your docs regularly to make sure that all the examples work, are up to date with the latest convex APIs and third party APIs.
If you want specific examples ill list them here as I find them.
First one is, your AI page (https://docs.convex.dev/ai) links to building a fullstack ChatGPT app (https://stack.convex.dev/full-stack-chatgpt-app) and that article gives an outdated way on how to configure the OpenAI sdk.. its also written in JS not TS (BTW this is an inconsistency that is all over Convex).
6 Replies
Another example is on this page: https://docs.convex.dev/file-storage/upload-files the code snippet shows
const convexSiteUrl = import.meta.env.VITE_CONVEX_SITE_URL; but if you try to run this you find out that VITE_CONVEX_SITE_URL is undefined. The docs dont mention how you are to get that URL as far as I can tellUploading and Storing Files | Convex Developer Hub
Files can be uploaded by your users and stored in Convex. You can choose to
Thanks for pointing these out! I've been trying to keep everything up to date but the more I write, the more there is to update.
w.r.t. JS/TS I hear you. Often I find the JS is easier to demonstrate the concepts, and we used to be pushing JS-first. Now that we're committed to TS, I should update that GPT app to be in typescript.
The openai version it targets is still correct, but the syntax has changed for the openai v4 API which came out recently. I'll put that on my todo list
For
VITE_CONVEX_SITE_URL that is a good catch. I'm not sure how that got in there. The corresponding code for the http demo is here: https://github.com/get-convex/convex-demos/blob/474555c62936be7ff35fc3b87ceb5243f56031b6/http/src/App.tsx#L18-L24GitHub
convex-demos/http/src/App.tsx at 474555c62936be7ff35fc3b87ceb5243f5...
Demo apps built on Convex. Contribute to get-convex/convex-demos development by creating an account on GitHub.
@nipunn can you check that out when you get a chance? ^
@mikeysee very much appreciate any other mistakes you find, please don't be shy about posting more here
Thanks for pointing these out! I've been trying to keep everything up to date but the more I write, the more there is to update.Haha ye I feel your pain. You guys have some great docs and you move fast but taking dependencies on third parties is always going to introduce these risks I guess 😛
very much appreciate any other mistakes you find, please don't be shy about posting more hereSure ill let you know here when I find others, there were definately more but I cant remember right now
I'll take a look at some point upcoming. Thanks for pointing it out.
If it's something you can/want fix with a PR - I'd be happy to look at that.