Skip to content

docs(readme): config-first Getting started + Troubleshooting#10

Open
srnnkls wants to merge 12 commits into
mainfrom
docs/readme-troubleshooting
Open

docs(readme): config-first Getting started + Troubleshooting#10
srnnkls wants to merge 12 commits into
mainfrom
docs/readme-troubleshooting

Conversation

@srnnkls

@srnnkls srnnkls commented Jun 9, 2026

Copy link
Copy Markdown
Owner

Two small, concise README changes (no new long-form content — that lands separately as GUIDE.md):

  1. Getting started leads with a minimal config. The first thing a reader sees after install is a runnable phora.toml + phora sync/phora verify, rather than prose. (the just move: show, don't describe.)
  2. Troubleshooting section. Maps the common "what's wrong?" questions to the command that answers them — check-match, verify, where, rebuild-registry — instead of leaving them as a flat list under "Maintenance / debugging". (the ripgrep move: answer the confusion proactively.)

Links out to GUIDE.md for depth (separate PR).

@srnnkls
srnnkls force-pushed the docs/readme-troubleshooting branch 2 times, most recently from 2b0b9c1 to 5089079 Compare June 11, 2026 10:36
srnnkls added 4 commits June 11, 2026 18:53
Lead with a minimal phora.toml + sync/verify so the first thing a reader
sees is a runnable config, and add a problem-oriented Troubleshooting
section that maps the common "what's wrong?" questions to check-match /
verify / where / rebuild-registry. Links out to the guide for depth.
…t flow

Show the zero-config `phora add` path ([targets.default], --to routing,
auto_target opt-out) before the hand-written config, matching the new
explicit-sources + default-target design.
@srnnkls
srnnkls force-pushed the docs/readme-troubleshooting branch from 5089079 to adf4652 Compare June 11, 2026 16:54
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