docs: add USE-CASES.md (situation-first recipes) - #28
Closed
srnnkls wants to merge 1 commit into
Closed
Conversation
One section per use case — dotfiles, agent artifacts, shared config across repos, release assets, subtree vendoring — each with a working config and an honest note on where phora stops (no templating, no hooks, copies not symlinks).
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
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
Adds
USE-CASES.md, a third documentation angle alongside the README (reference, #10) and GUIDE.md (walkthrough, #11): each section starts from a situation and shows a working config for it.Covered:
~/.configtarget, machine differences viaphora.local.toml, the--symlinkdev loop, and an explicit Where phora stops note (no templating, no hooks, copies not symlinks) with a fair pointer to dotter/chezmoi for setups that lean on those.includenarrowing,by-sourcebundles, link-mode skill development,verifyin CI.verify, side-by-sidecurrent/nextversions via per-binding refs; nods to vendir as the same instinct.curl | tar, digest-before-extraction, auto-strip, no lock churn on unchanged bytes.Notes
phora.example.toml/GUIDE semantics; artifact-lands-as-directory is respected in every layout example.GUIDE.mdlink resolves once docs: add GUIDE.md (extensive walkthrough + internals) #11 merges; thetests/scrut/showcase.mdlink is already on main.