docs: make self-hosting and contribution guides clearer - #808
izadoesdev wants to merge 4 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI Review profile: ASSERTIVE Plan: Advanced Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
The latest updates on your projects. Learn more about Unkey Deploy
|
f131b44 to
b442e56
Compare
The README now gives founders, self-hosters, and contributors a clear starting point. It replaces stale badges, speculative features, and repeated FAQs with a short product introduction and direct links to each path.
Self-host instructions start from the short self-host environment template and cover direct ClickHouse delivery, disabled hosted billing and Databuddy telemetry, and optional email and AI. Setup and upgrades cover matching releases, secret generation, public URLs, database prompts, and DQL's separate setup. The contributor guide fixes outdated commands and keeps the branch/review workflow. The AI policy keeps disclosure, accepted-issue, human-verification, media, and enforcement requirements while removing personal attacks and public-shaming language.
The three guides are about one-third shorter than the previous versions, including the setup draft's README. Documentation only; no runtime changes.
Validation and dependencies
databuddy-inityet. The README says so; update that notice once a compatible release and all its service images are published.AI-assisted writing and verification with Codex; draft for maintainer review.