Back
Post
Should I build a public website or the github README is enough for an Open Source project?
I'm building https://github.com/madarco/ragrabbit and I'm working on improving docs and the README.
Should I build a website?
Should I build a website?
👋 Join WIP to participate
Start with a README. If it starts getting lengthy (more than a few pages of info) build a simple landing page with 2 links:
Get Started (links to "quickstart" in the relevant section of the readme or wherever this info is)
View Docs (links to full docs site). I've used GitBook for this kind of stuff before.
but what do you think about the "image" of the project? I'd like to promote collaboration on this open source effort that I think a lot of devs might find useful to bootstrap other RAG/AI apps in Next.js. I'd like to avoid to feel too commercial.
Do you think a website might be a problem with that?
If you design the website to look overly commercial, then yes it will be a problem
If you keep it simple it won’t be
good point, thanks!
The main constraint used to be time, but now with AI you can spin up something decent very quickly in less than an hour.
yeah exactly I already built it at 90%, I was just worried about giving the wrong idea about the project, I want it to be open and foster collaboration
You need a great Readme anyway, so start with it