docs(readme): config-first Getting started + Troubleshooting - #10
Closed
srnnkls wants to merge 12 commits into
Closed
docs(readme): config-first Getting started + Troubleshooting#10srnnkls wants to merge 12 commits into
srnnkls wants to merge 12 commits into
Conversation
srnnkls
force-pushed
the
docs/readme-troubleshooting
branch
2 times, most recently
from
June 11, 2026 10:36
2b0b9c1 to
5089079
Compare
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
force-pushed
the
docs/readme-troubleshooting
branch
from
June 11, 2026 16:54
5089079 to
adf4652
Compare
Forge sources use repo (not the deprecated path alias) in the getting-started example; remove bold emphasis throughout (italics only, sparingly); drop the out-of-scope/auth note.
Owner
Author
|
Superseded by #67, which consolidates this work with the other two docs PRs. These three branches each forked from a commit predating the source → projection → sync reorganization, and they cross-reference each other — README links the guide, USE-CASES links the guide — so landing them separately would have left broken links between merges. #11 also carried scrut changes that conflicted with contracts now on main, including the whole-run Your work is preserved: GUIDE.md and USE-CASES.md were seeded verbatim from these branches as commit 1153a54, and every subsequent change is a reviewable diff on top of them. The four scrut suites main lacked came across too. |
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.
Two small, concise README changes (no new long-form content — that lands separately as
GUIDE.md):phora.toml+phora sync/phora verify, rather than prose. (thejustmove: show, don't describe.)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.mdfor depth (separate PR).