diff options
Diffstat (limited to 'fahrenheit-451/references')
5 files changed, 115 insertions, 0 deletions
diff --git a/fahrenheit-451/references/contradiction-register-template.md b/fahrenheit-451/references/contradiction-register-template.md new file mode 100644 index 0000000..ef779d4 --- /dev/null +++ b/fahrenheit-451/references/contradiction-register-template.md @@ -0,0 +1,15 @@ +# Contradiction Register Template + +Use this for genuine doc-vs-code contradictions where supersession is unclear. + +```text +| doc_path | code_anchor | contradiction | possible_precedence | why_unclear | action_needed | +|----------|-------------|---------------|---------------------|-------------|---------------| +| docs/protocol.md | crates/protocol/src/lib.rs | doc says field is required; code treats it as optional | doc_or_code_unclear | public contract vs implementation drift | human decision | +``` + +Rules: + +- record only real contradictions, not vague doubts +- if precedence is obvious, update the loser instead of logging it here +- unresolved entries must be surfaced in the final response diff --git a/fahrenheit-451/references/file-decision-ledger-template.md b/fahrenheit-451/references/file-decision-ledger-template.md new file mode 100644 index 0000000..5299ae4 --- /dev/null +++ b/fahrenheit-451/references/file-decision-ledger-template.md @@ -0,0 +1,28 @@ +# File Decision Ledger Template + +Use one row per file. + +```text +| path | doc_kind | audience | disposition | keep_or_delete_basis | superseded_by_or_merge_target | rewrite_needed | code_reconciliation_target | +|------|----------|----------|-------------|----------------------|-------------------------------|----------------|----------------------------| +| docs/protocol.md | formal_spec | developers | keep_as_is | foundational definition already vetted | | no | crates/protocol/src/lib.rs | +| docs/roadmap.md | roadmap | internal | delete | shipped history plus stale plans | | no | | +| docs/setup.md | runbook | operators | rewrite_from_scratch | still needed but bloated and partially stale | | yes | scripts/deploy.sh | +| notes/old-api.md | feature_doc | developers | merge_then_delete | scarce useful material belongs in docs/api.md | docs/api.md | no | crates/api/src/lib.rs | +``` + +Allowed `disposition` values: + +- `delete` +- `merge_then_delete` +- `rewrite_from_scratch` +- `light_edit` +- `keep_as_is` +- `flag_contradiction` + +Rules: + +- every file must end in exactly one disposition +- `keep_or_delete_basis` can be short, but it must be concrete +- `rewrite_needed` should normally be `yes` for any surviving non-foundational doc +- `code_reconciliation_target` is required for every surviving or contradiction-flagged file diff --git a/fahrenheit-451/references/file-manifest-template.md b/fahrenheit-451/references/file-manifest-template.md new file mode 100644 index 0000000..73cb830 --- /dev/null +++ b/fahrenheit-451/references/file-manifest-template.md @@ -0,0 +1,19 @@ +# File Manifest Template + +```text +scope_root: +inspection_mode: audit_only | audit_plus_refactor +wave_size_limit: 8 + +files: +- [ ] docs/file_a.md +- [ ] docs/file_b.txt +- [ ] notes/file_c.org +``` + +Rules: + +- include every plaintext doc-like file in scope +- mark files as inspected only after reading them +- allow files to appear in multiple clique waves +- reuse the same manifest for the final residual sweep diff --git a/fahrenheit-451/references/read-cluster-template.md b/fahrenheit-451/references/read-cluster-template.md new file mode 100644 index 0000000..d52c0aa --- /dev/null +++ b/fahrenheit-451/references/read-cluster-template.md @@ -0,0 +1,26 @@ +# Read Cluster Template + +```text +clique_id: +purpose: +why_these_files_belong_together: +wave_size: + +files: +- path/to/file_a.md +- path/to/file_b.txt + +checkpoint: +- deletion candidates: +- merger candidates: +- possible keepers: +- likely rereads: +- code surfaces to reconcile: +``` + +Rules: + +- `wave_size` must never exceed `8` +- write the checkpoint into the `/tmp` worklog after every wave before reading more files +- a file may appear in multiple cliques when supersession or duplication reasoning demands it +- name the clique by the relationship it is testing, not by arbitrary adjacency diff --git a/fahrenheit-451/references/tmp-worklog-template.md b/fahrenheit-451/references/tmp-worklog-template.md new file mode 100644 index 0000000..c2037b2 --- /dev/null +++ b/fahrenheit-451/references/tmp-worklog-template.md @@ -0,0 +1,27 @@ +# /tmp Worklog Template + +```text +worklog_path: +scope_root: +inspection_mode: audit_only | audit_plus_refactor +wave_size_limit: 8 + +manifest: + +clique_plan: + +wave_checkpoints: + +file_decision_ledger: + +contradiction_register: + +residual_summary: +``` + +Rules: + +- create this file before the first file read +- update it after every 8-file wave before reading more files +- treat it as the durable source of truth for the run +- report the final worklog path in the user-facing response |