Skip to content

docs: make self-hosting and contribution guides clearer - #808

Draft
izadoesdev wants to merge 4 commits into
stagingfrom
codex/selfhost-contributor-copy
Draft

izadoesdev wants to merge 4 commits into
stagingfrom
codex/selfhost-contributor-copy

Conversation

@izadoesdev

@izadoesdev izadoesdev commented Sep 16, 2026

Copy link
Copy Markdown
Member

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

AI-assisted writing and verification with Codex; draft for maintainer review.

@vercel

vercel Bot commented Sep 16, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
dashboard Ready Ready Preview Sep 16, 2026 8:14pm UTC
databuddy-status Ready Ready Preview Sep 16, 2026 8:14pm UTC
documentation Ready Ready Preview Sep 16, 2026 8:14pm UTC

@coderabbitai

coderabbitai Bot commented Sep 16, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 52705792-8ef7-4f76-89d7-2d81c7c6698a

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@unkey-deploy

unkey-deploy Bot commented Sep 16, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Unkey Deploy

Name Status Preview Inspect Updated (UTC)
links (preview) Ready Visit Preview Inspect Sep 16, 2026 8:12pm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant