docs: reconcile README, /repi/docs, CLAUDE.md with config-only flow#42
Merged
Conversation
The three docs disagreed with the code after the PR #40 merge. Sweep them so a new user lands on consistent instructions across the README, the marketing/docs page, and the agent-facing CLAUDE.md. README - "Run with Docker (quickstart)": replace the all-in-one-profile invocation with plain `docker compose up -d`. Document the entrypoint-seeds-config-on-first-start flow, the volume persistence semantics (`down` keeps, `down -v` wipes), and the "supply key via UI" first-run experience. - "Configuration": drop the "shell env overrides config.json" line. config.json is the sole source; `.env` is no longer read. Update the legacy-checkout note to mention root `.env` too. - "Environment Variables" → "Configuration keys": rename the section to match reality, lead with "all keys live in .repi/config.json", add LOG_LEVEL row, add docker-default note on DATABASE_URL / REDIS_URL, fold the per-provider key names into one row. CLAUDE.md - "Commands": split into Path 1a (contributor) and Path 1b (docker compose up against the published image), each with a one-liner description. - Architecture tree: correct the `core/config.py` and `llm/factory.py` comments (no env reads anymore); call out lazy ST in `core/container.py`. - "Configuration": rewrite the precedence paragraph. config.json is the sole source via `settings_customise_sources`. Document the two ways the file gets seeded (host vs docker), the partial-merge semantics of `PUT /config`, and the PUT-as-PATCH TODO. Add LOG_LEVEL to the optional list, note the docker-aware DATABASE_URL/REDIS_URL defaults. /repi/docs page (web/app/repi/docs/page.tsx) - Quickstart step 2 note: "writes .env" → "writes .repi/config.json". - Multi-LLM feature card: drop "single environment variable", replace with "one line of .repi/config.json (or one click in the UI)". - Configuration section subtitle: replace "Set via env vars or .env" with "All settings live in .repi/config.json; env / .env intentionally ignored." - Config table: add LOG_LEVEL row; rename "Variable" column to "Key". - Navbar + footer link labels: "Env Vars" → "Config". Anchors stay `#env-vars` to keep external links working. Verified: 74/74 tests still pass; `tsc --noEmit` clean.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The three install-facing docs disagreed with the code after PR #40 merged. This sweeps them so a new user lands on consistent instructions whether they read the README, hit `/repi/docs`, or pair with Claude Code via CLAUDE.md.
README
CLAUDE.md
/repi/docs page (web/app/repi/docs/page.tsx)
Test plan