Skip to content

docs: add USE-CASES.md (situation-first recipes) - #28

Closed
srnnkls wants to merge 1 commit into
mainfrom
docs/use-cases
Closed

docs: add USE-CASES.md (situation-first recipes)#28
srnnkls wants to merge 1 commit into
mainfrom
docs/use-cases

Conversation

@srnnkls

@srnnkls srnnkls commented Jun 12, 2026

Copy link
Copy Markdown
Owner

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:

  • Dotfiles — slices per ~/.config target, machine differences via phora.local.toml, the --symlink dev 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.
  • Agent artifacts — skills/subagents/prompts pinned per project, per-project include narrowing, by-source bundles, link-mode skill development, verify in CI.
  • Shared configuration across repositories — per-repo locks as the rollout mechanism, CI conformance via verify, side-by-side current/next versions via per-binding refs; nods to vendir as the same instinct.
  • Release assets — URL sources vs curl | tar, digest-before-extraction, auto-strip, no lock churn on unchanged bytes.
  • Subtree vendoring — protos/schemas/tokens from a larger repo, pinned and upgradable per consumer.
  • A short other shapes list (git hook files, runbooks, reference checkouts).

Notes

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).
@srnnkls

srnnkls commented Aug 11, 2026

Copy link
Copy Markdown
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 pre_deploy abort atomicity.

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.

@srnnkls srnnkls closed this Aug 11, 2026
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