Skip to content

Reconcile promise with the org docs corpus at docs-2026.2 #63

Description

@djabi

The reconciliation pass for org docs release docs-2026.2, per docs/org/normative.md §7: walk each vendored document against this project and file an item for every gap found, each under the matching document's label. This item closes when every found gap has its own filed item. Promise's pass is the deepest in the fleet, because much of the corpus was synthesized from this repository — so the gaps here are mostly retirements and de-duplications, each a deliberate reviewed change.

Known starting points:

  • docs/normative.md is superseded by org/normative.md — archive it, repoint every reference (CLAUDE.md's Documentation section restates its location table; CONTRIBUTING links it), and resolve the two deliberate differences: the org doc's tag line names the query via docs/index.md (this repo's is the tracker query), and the org doc keeps promise's research/ row. (normative)
  • CLAUDE.md's language-semantics marker exception contradicts §3 — normative.md forbids inline tracker-item markers; CLAUDE.md grants a narrow exception (tracked as T… markers deleted when the item closes). Either the exception is proposed upstream against org, or it is dropped here. It is currently a live self-contradiction. (normative)
  • docs/code-style.md is absorbed by org/engineering-guide.md + org/engineering-guide-promise.md — archive it and repoint CONTRIBUTING and CLAUDE.md. The one fact to preserve: it is the origin of the getter-cost-signal and field-naming rules; nothing may be lost in the diff. (engineering-guide-promise)
  • docs/build-tools.md §Scope error stands: it and gate-system.md both claim checkDocIndex covers "the top level of docs/ only" while the code and normative §8 say recursive — the same wrong sentence in two homes. (normative)
  • Environment variables vs the guides: PROMISE_PROGRESS (an input in NO_COLOR style), PROMISE_BLOB_MIRROR (configuration to the installer/stub) against org/cli-guide.md §2 — the stub is an end-user product, so scope rulings are needed, possibly filed upstream against org. PROMISE_GATE is a containment marker and already sanctioned. (cli-guide)
  • CLI conformance of bin/ tools and promise itself against org/cli-guide.md: -help/-version uniformity, boolean -no- pairs, one-order rule, -json-input. (cli-guide)
  • Prompt-embedded rule copies: the .claude/skills and workspace-side promise templates carry rules the org guide absorbed; per "prompts point here", they slim to citations once the corpus is stable. (engineering-guide)
  • gate-system.md vs base's gate-contract.md vocabulary reconciliation — the long-standing two-taxonomy overlap, larger than this pass but anchored from it. (normative)

A defect found in a document itself is filed against promise-language/org, not here (docs/org/normative.md §7).

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    normativeGaps against docs/org/normative.md

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions