Skip to content

UW Markdown RFCs ​

This directory contains the request-for-comments documents that precede any normative change to UW Markdown — the format spec, the protocol spec, the JSON Schemas, the conformance corpus, or the public API of @uwmd/core.

See GOVERNANCE.md for when an RFC is required and how it gets accepted.

Process ​

  1. Copy 0000-template.md to NNNN-<short-slug>.md using the next free number.
  2. Fill in the design, compatibility, conformance, and implementation sections.
  3. Open a pull request or, in owner-led mode, commit it with the implementation.
  4. The project owner accepts, requests changes, or rejects the proposal.
  5. In owner-led mode there is no mandatory waiting period. After collaborative mode activates under GOVERNANCE.md, a normative RFC remains open for public comment for at least 14 days before acceptance.
  6. Accepted RFCs move to accepted; after the implementation ships, they move to implemented. Rejected and superseded RFCs remain as design history.
  7. An RFC whose own deliverable is the decision — it defines no fields and ships no code — is decided rather than accepted, and that is terminal. See Status values for the full vocabulary and for how decided differs from accepted.

Index ​

#TitleStatusAffects
0001Locale negotiationimplementedformat, protocol, core, conformance
0002Module signingimplementedprotocol, core, conformance, tooling
0003Custom asset-class declarations from modulesimplementedformat, protocol, core, conformance, tooling
0004Conformance test runner v2 (language-agnostic)implementedprotocol, core, conformance, tooling
0005Stochastic calculationsimplementedprotocol, core, conformance
0006Hospitality reference moduleimplementedcore, conformance, tooling
0007Sensitivity tables as a calc primitiveimplementedprotocol, core, conformance
0008Lease-up modelingimplementedprotocol, core, conformance
0009_meta v2 sub-object reorganizationimplementedformat, protocol, core, conformance
0010Signed blocksimplementedformat, protocol, core, conformance, tooling
0011Capability tokens for write authorizationimplementedprotocol, core, conformance
0013Embedding-based corpus retrievaldraftprotocol, core, conformance
0014Extensible multi-format interchangeimplementedformat, protocol, core, conformance, tooling
0015Portfolio and relationship profilesimplementedformat, protocol, core, conformance, tooling
0016Signed deterministic verification receiptsimplementedformat, protocol, core, conformance, tooling
0017.uw.md Lite / .uwx.md Extended source splitimplementedformat, protocol, core, conformance, tooling
0018Composable document profiles and deal packagesimplementedformat, protocol, core, conformance, tooling
0019Mixed-use composition as a document shapeimplementedformat, protocol, core, conformance, tooling
0020Align the format spec and examples with .uwx.mdimplementedformat, protocol, conformance, tooling
0021Composable UWX documents — externalization, composites, rollup receiptsimplementedformat, protocol, core, conformance, tooling
0022Market data as an attributable UW documentimplementedformat, protocol, core, conformance, tooling
0023A numeric model and a single quantization boundaryimplementedprotocol, core, conformance, tooling
0024Pin the iterative solvers so two engines agree on a rootimplementedprotocol, core, conformance
0025Scale percent displays by moving the point, not by dividingimplementedformat, core, conformance
0026A typed capital stack — tranches, preferred equity, and stack-aware sizingimplementedformat, protocol, core, conformance, tooling
0027Declare every asset class's size intensive, onceimplementedformat, protocol, core, conformance, tooling
0028Make a missing required section a reportable defectimplementedformat, core, conformance
0029Make stage requirements class-awareimplementedformat, core, conformance
0030Make partial conformance mechanically checkableimplementedprotocol, core, conformance, tooling
0031Reconcile the source vocabularies and close the unpoliced-write pathimplementedformat, protocol, core, conformance, tooling
0032State how _meta.provisional interacts with signingimplementedprotocol
0033Scope capital_stack to one point in timeimplementedformat
0034Calendar-anchored cash flows — dated series, day counts, deterministic xirr/xnpvimplementedformat, protocol, core, conformance
0035Distribution waterfall — state-and-verify promote, pref, and catch-up over a dated seriesimplementedformat, protocol, core, conformance
0036IRR-hurdled waterfall tiers — a closed-form boundary, not a nested solveimplementedformat, protocol, core, conformance
0037Cross-check resolution over variant maps, and a validation coverage channelimplementedformat, protocol, core, conformance
0038Tax basis on stated return metricsimplementedformat, protocol, core, conformance
0039Data-center module — the first product module on a module-declared asset classimplementedcore, conformance, tooling
0040Variant roles — resolve cross-checks by a declared role, not a key nameimplementedformat, protocol, core, conformance
0041Explicit period addressing for the standard seriesimplementedformat, protocol, core, conformance
0042Stated period inputs in refinementimplementedprotocol, core
0043Contextual Excel period bindingsimplementedprotocol, core, tooling
0044Project verified lease-up amounts onto explicit cash datesimplementedprotocol, core, conformance, tooling
0045Assemble explicitly covered property cash flowsimplementedprotocol, core, conformance, tooling
0046Document currency identityimplementedformat, protocol, core, conformance
0047Property cash-flow input inventoryimplementedcore, tooling
0048Standalone UW document kit and package examplesimplementedconformance, tooling, documentation
0049PostgreSQL JSONB lake adapter boundaryimplementedtooling, documentation
0050Preferred equity with a split couponimplementedformat, protocol, core, conformance
0051Distribution waterfall dual-hurdle "any" modeimplementedformat, protocol, core, conformance
0052Named exit sale deductionsimplementedprotocol, core, conformance
0053Tax abatements and reassessment basisimplementedformat, protocol, core, conformance
0054Where per-lease economics live (decision)decidedformat, documentation
0055Typed commercial lease clausesimplementedformat, protocol, core, conformance
0056Typed rate hedges, escrows and the reserves that fund themimplementedformat, protocol, core, conformance
0057The renovation draw, and capex that buys an expense reductionimplementedformat, protocol, core, conformance
0058Expense recoveries and the CAM true-upimplementedformat, protocol, core, conformance
0059Waterfall clawback as a terminal true-upimplementedformat, protocol, core, conformance
0060The four tranche-class candidates (decision)decideddocumentation
0061Keep protocol version labels synchronizedimplementedprotocol, tooling, documentation
0062Permit same-day cash-flow rows while refusing ambiguous selectorsimplementedformat, protocol, core, conformance
0063Admit disposition at the final calendar period's exclusive boundaryimplementedprotocol, core, conformance, tooling
0064Verify property reserve-account roll-forwards without netting expenditureimplementedformat, protocol, core, conformance, tooling
0065Bind a stated reserve draw to an already-stated gross expenditureimplementedformat, protocol, core, conformance, tooling
0066Resolve calc identifiers over variant-map sections the way cross-checks doimplementedprotocol, core, conformance, tooling
0067Tenure and ground-lease contractdraftformat, protocol, core, conformance
0068Manufactured-housing module — a community leased by the site, with park-owned homes as a second income linesupersededcore, conformance, tooling
0069Declare the student rent-roll bed counts and pre-leasing dates the student pack already readsimplementedformat, protocol, core, conformance
0070Bind outright replacement-cap funding to an exact modeled cash paymentimplementedformat, protocol, core, conformance, tooling
0071A calendar-date validity predicate for safe expressionsimplementedprotocol, core, conformance, documentation
0072Give frontmatter scenario a defined meaningimplementedformat, core, conformance, tooling
0073Previous identifiers for module-declared asset classesdraftprotocol, core, conformance
0074What a dependent module's declaration override meansimplementedprotocol, core, conformance
0075Read a rate hedge from the senior loan when debt_structure is a role mapimplementedformat, protocol, core, conformance
0076Refuse a stated rate hedge whose loan or cash lines cannot be selectedimplementedformat, protocol, core, conformance
0077Define exit proceeds to equity when the capital stack carries junior capitalimplementedformat, core, conformance, tooling
0078The protocol is verification: separate the standard from the starter productsimplementedprotocol, format, conformance, core, tooling
0079Verify stated metrics at their stated precision; one cash-on-cash definitionimplementedprotocol, core, conformance, tooling
0080Every official asset class is a builtinimplementedformat, protocol, core, conformance, tooling
0081One format, one protocol: remove backward compatibility (pre-release cleanup)implementedformat, protocol, core, conformance, tooling
0082A borrower-underwriting document profile for a loan to an operating companydraftformat, protocol, core, conformance, tooling
0083Split @uwmd/verify, the reference implementation of the standard, out of @uwmd/coreimplementedcore, conformance, tooling
0084Bind a document snapshot without discarding signed block attributionimplementedprotocol, core, conformance, tooling
0085Keep full records as verification subjects and remove destructive compactionacceptedformat, protocol, core, conformance, tooling
0086One purchase-price authority for data-center metrics, with the summary cross-checkedacceptedformat, protocol, core, conformance, tooling
0087Define the basis for hospitality revenue reconciliationdraftformat, protocol, core, conformance, tooling
0088Resolve financial power and transcendental reproducibilityacceptedprotocol, core, conformance
0089Preserve extension variants in a complete versioned Envelopeacceptedformat, protocol, core, conformance, tooling
0090Admit required provenance actors with an explicit diagnosticacceptedformat, protocol, core, conformance, tooling
0091Allocate the two required metadata boolean diagnosticsacceptedformat, protocol, core, conformance, tooling
0092Verify stated pro forma identities under declared conventionsacceptedformat, protocol, core, conformance
0093Close three metadata-shape diagnostic gapsacceptedformat, protocol, core, conformance, tooling
0094Allocate three present-invalid metadata leaf diagnosticsacceptedformat, protocol, core, conformance, tooling
0095Allocate bounded optional metadata and provenance-reference diagnosticsacceptedformat, protocol, core, conformance, tooling
0096Allocate bounded stated-payload admission diagnosticsacceptedformat, protocol, core, conformance, tooling
0097Refuse invalid selected institution configuration before validationacceptedformat, protocol, core, conformance, tooling
0098Declare the point in time of the capital stack and senior loans, and reconcile CC-03 per pointacceptedformat, protocol, core, conformance, tooling
0099Verify each dictionary metric wherever the document states itacceptedformat, protocol, core, conformance, tooling
0100Refuse negative sizes, counts, areas and rentsacceptedformat, protocol, core, conformance, tooling
0101Refuse every present source value outside the actor grammaracceptedformat, core, conformance
0102A structured block opens only on a three-backtick json lineacceptedformat, conformance, tooling
0103Four metric dictionary corrections — USALI F&B gross margin, data-center mark-to-market and drawn power, booked rooms revenueacceptedformat, core, conformance, tooling
0104Validation issue field paths are dotted paths from the payload root; issue order is not normativeacceptedprotocol, core, conformance
0105Name the field each financial-validity threshold reads, and check each stated homeacceptedformat, core, conformance
0106Refuse a structured block whose JSON is not an I-JSON objectacceptedformat, protocol, core, conformance
0107Give the LTC band a Format-defined home and an FV codeacceptedformat, protocol, core, conformance
0108Align the §4.17 validation section's vocabulary with the validation resultacceptedformat, conformance
0109Report financial-validity findings as deal flags, not record errorsacceptedformat, protocol, core, conformance, tooling
0110Name the §4.17 financial_validity entry's band "band", as RFC 0109 doesacceptedformat, conformance
0111Verify each record under the rule set of the version it declaresacceptedformat, protocol, conformance, core
0112Remove the retired agent host layer vocabulary from the standardacceptedformat, protocol, core, conformance, tooling
0113Define hospitality occupied room nights as paid room nights soldacceptedformat, conformance
0114Record the area measurement standard behind per-area metricsacceptedformat, protocol, core, conformance
0115Portable conformance subcommands for every Verifier obligationacceptedprotocol, conformance, core
0116Stage readiness by class section, a scope minimum in Format fields, and present meaning statedacceptedformat, protocol, core, conformance, tooling
0117Extend the size contract to mixed-use component sizes and guard the per-size component metricsacceptedformat, protocol, core, conformance
0118Refuse closed frontmatter values outside their vocabulariesacceptedformat, protocol, core, conformance
0119Compare NOI by absolute difference when it is zero or negative (CC-05, CC-06)acceptedformat, protocol, core, conformance
0120Preserve selected-source cash-flow structural findingsacceptedformat, protocol, core, conformance
0121Bound CS-01 to tranche identities and required membersacceptedformat, protocol, core, conformance
0122Make DQ-05 date parsing deterministicacceptedformat, protocol, core, conformance
0123Recompute dictionary-defined receipt results without a starter packacceptedformat, protocol, core, conformance
0124Require an explicit rule-set declaration in every source representationacceptedformat, protocol, core, conformance
0125Verify data-center purchase price per stated rentable square footacceptedformat, protocol, core, conformance
0126Verify the stated land carry-NOI identityacceptedformat, protocol, core, conformance
0127Portable receipt engine identity in conformanceacceptedprotocol test configuration, conformance, Python
0128RFC0092 admission, ledger roles and reportsacceptedprotocol, schemas, reference verification, conformance

| 0129 | Catalog document families and three attributable fact profiles | accepted | format, protocol, reference library, conformance | | 0130 | Give indeterminate receipt verification a distinct nonzero exit | accepted | protocol, conformance, tooling | | 0131 | Preserve authored sparse-statement aggregates | accepted | | 0132 | Separate physical and economic occupancy | accepted | | 0133 | Align malformed input-hash diagnostics | accepted |

0012 is an unused number, left as a gap so existing references keep their meaning. RFC 0017 is retroactive: it documents a change that shipped before its RFC was written, and records that process failure rather than hiding it. See its Process failure section.

Status values ​

This is the authoritative list. An RFC's frontmatter status: must be one of these values, and npm run verify-indexes fails on any other.

  • draft — author is still iterating; reviewers may comment but the proposal is not stable.
  • active — open for comment; the 14-day minimum applies in collaborative mode.
  • accepted — merged with intent to implement, and this RFC itself still promises implementation that has not shipped.
  • decided — terminal. The RFC's own deliverable is the architectural or design decision, and it explicitly promises no implementation of its own.
  • implemented — the change has shipped in a release; CHANGELOG entry exists.
  • rejected — closed without merging the change. RFC stays in the directory.
  • superseded — replaced by a later RFC; cross-link both.
  • withdrawn — author pulled the proposal.

accepted versus decided ​

The test is what this RFC promises, not whether any work remains in the area.

A decided RFC may identify implementation that a separate future RFC would have to carry. That deferral does not demote it to accepted, because the deferred work was never this RFC's deliverable — there is nothing here left to ship, so it never becomes implemented.

RFC 0054 is the worked example: it decides where per-lease economics live, states outright that it "defines no fields and implements nothing", types the lease clauses through RFC 0055, and defers the periodic series until a consumer exists. It is decided, not accepted, even though it names future work.

Use accepted when the RFC in hand describes a change that is still owed.

When status changes, edit the RFC's frontmatter and update this index.

Released under the MIT License.