docs: typed-fault consistency pass (ADR-0011, rpc, migration, house-style)#436
Open
lgahdl wants to merge 1 commit into
Open
docs: typed-fault consistency pass (ADR-0011, rpc, migration, house-style)#436lgahdl wants to merge 1 commit into
lgahdl wants to merge 1 commit into
Conversation
…tyle)
- ADR-0011: the orderbook rejection description was {errorType,
description}; nullislabs#219 restored the data payload, so it's
{errorType, description, data} - fixed the one place this doc said
otherwise.
- docs/07-rpc-namespace-design.md: same fix, two spots (the WIT
record's own doc comment, and a code comment referencing the
parsed shape). The record definition two lines below the first fix
already had the correct 4-field shape.
- docs/migration/0.1-to-0.2.md: the data payload was never called out
here at all - added a cow-api WIT snippet mirroring the existing
chain-error one, spelling out order-rejection's full shape.
- docs/production.md: house-style pass, 22 em-dashes to ASCII hyphens.
Not fixed: the issue's fourth bullet (stale committed diagram .png
renders needing regeneration, blocked on mermaid-cli) no longer
applies - grepped the whole tree for any committed .png/.svg/.jpg and
found none. Diagrams render inline via mermaid code blocks in
docs/diagrams/diagrams.md (GitHub renders these natively, no build
step), not from pre-rendered images. Separately, the standalone .mmd
files under docs/diagrams/ are now orphaned - they no longer match
diagrams.md's inline content - but reconciling or removing them is a
distinct problem from what this issue asked for, so left as a
follow-up rather than folded in here.
Fixes nullislabs#289.
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
1 participant
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
Fixes #289. Docs pass over the typed-fault vocabulary (epic #206) catching up with #219's restoration of the cow rejection's
datapayload, plus a house-style pass.{errorType, description}; fix(runtime): whole-train hardening for the typed-fault stack #219 restoreddata, so it's{errorType, description, data}— fixed the one place this said otherwise.docs/07-rpc-namespace-design.md: same fix, two spots — the WIT record's own doc comment, and a code comment referencing the parsed shape. The actual record definition two lines below the first fix already had the correct 4-field shape (status,error-type,description,data).docs/migration/0.1-to-0.2.md: thedatapayload wasn't called out here at all. Added acow-apiWIT snippet mirroring the existingchain-errorone, spelling outorder-rejection's full shape.docs/production.md: house-style pass, 22 em-dashes → ASCII hyphens (matching the-convention used throughoutdocs/*.mdand the ADRs).Not fixed: the issue's fourth bullet — stale committed diagram
.pngrenders needing regeneration, blocked onmermaid-cli— no longer applies. Grepped the whole tracked tree for any committed.png/.svg/.jpg: none exist. Diagrams render inline via mermaid code blocks indocs/diagrams/diagrams.md(GitHub renders these natively, no build step, no pre-rendered image to go stale). Separately, the standalone.mmdfiles underdocs/diagrams/are now orphaned — they no longer matchdiagrams.md's inline content — but reconciling or removing them is a distinct problem from what this issue asked for (image-vs-source sync), so left as a follow-up rather than folded in here.No code changes — pure documentation.
Test plan
{errorType, description}references remain.png/.svg/.jpgto confirm the diagram-regeneration bullet is moot