docs: bring DOCS into line with multi-bit wires and topology v02 - #70
Merged
Conversation
Multi-bit support is now a real part of the surface. Update the documentation set so the language reference, decisions log, runtime contract, preview reference, and getting-started walkthrough all describe the world as compiled today. - DOCS/language.md: declarations and signals carry `[N]` width annotations; new §6 covers literal widths, slice / bit-index / concat (low operand on the left), parametric sub-circuits via `<W>`/`[W]`, and parametric built-in macros. - DOCS/decisions/language.md: append a Multi-bit wires section with the locked decisions (LSB=0 bit numbering, half-open slice, concat ordering, parameter scope, default width 1, E014/E015/E016 codes, BigInt WASM ABI, topology v02). - DOCS/circuit-format.md: width annotation in the syntax overview, per-kind width rules in the primitives table, slice / concat / bit-index in the signal grammar, topology v02, diagnostics table. - DOCS/simulation-engine.md: pool storage described as lazily allocated multi-tier; ComponentType / Component.Kind extended with slice and concat; per-kind port-name table extended; remove the stale width=1-only caveats. - DOCS/architecture.md: rewrite the width=1 caveat to reflect the lazily-allocated multi-tier layout. - DOCS/preview.md: document --expand-display, multi-bit pin labels, and the three LED rendering modes; bump section magic to v02. - DOCS/getting-started.md: migrate the Node walkthrough to the BigInt paired ABI (setPin(id,value,defined), getOutputValue/getOutputDefined) and add a multi-bit driving example. - CLAUDE.md: rewrite fact #7 in the engine summary; re-aim the plan pointer at the archived path. - DOCS/archive/{index.md,plan-multi-bit-language.md}: archive the multi-bit plan and add its index row.
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
DOCS/in line with it.[N]width annotations, slice / bit-index / concat, parametric sub-circuits via<W>/[W], parametric built-in macros, the BigInt paired WASM ABI, and topology format v02.architecture.md,simulation-engine.md, andCLAUDE.md; new E014 / E015 / E016 codes added to the diagnostics table; the multi-bit plan moved underDOCS/archive/.Test plan
DOCS/language.md↔circuit-format.md↔wasm-api.md).DOCS/archive/index.mdrow points at the moved file path.