Skip to content

fix: preserve continuation-line glossary definitions - #47

Closed
arunimshukla wants to merge 1 commit into
ethsystems:mainfrom
arunimshukla:fix/multiline-glossary-definitions
Closed

arunimshukla wants to merge 1 commit into
ethsystems:mainfrom
arunimshukla:fix/multiline-glossary-definitions

Conversation

@arunimshukla

Copy link
Copy Markdown
Contributor

Summary

parseGlossary() only reads definition text from the glossary term line. In the current map content, Data Availability Layer (DA Layer) places its definition on the immediately following line, so the generated entry contains an empty definition and is omitted from the public glossary.

This change:

  • reads the immediate next line when the inline definition is empty
  • refuses to consume a category heading or another glossary term
  • preserves existing single-line and linked-term parsing
  • regenerates src/data/glossary.json with the missing DA Layer definition

The earlier glossary-link work from #45 is now present on main through commit 63f99bd. This is an independent follow-up based on that commit.

Reproduction

Against current main:

  • the graph build reports 74 glossary terms
  • Data Availability Layer (DA Layer) is generated with "definition": ""

After this patch, the term count remains 74 and the source definition is preserved.

Regression coverage

The tests cover:

  • a definition on the immediate continuation line
  • a missing definition followed by another term
  • a missing definition followed by another category
  • existing linked-term and inline-definition behaviour

Validation

  • npm test: 61/61 passed
  • npm run lint:refs: passed
  • npm run build: passed, 218 pages built

rymnc pushed a commit that referenced this pull request Oct 5, 2026
Cherry-picks #46 (sibling RFP links), #47
(continuation-line glossary definitions), and #48 (Custom
UTXO link to Shielding), preserving @arunimshukla as commit author.
Clean picks onto main; tests pass (62/62).

Prompted by: ac

---------

Co-authored-by: Arunim Shukla <54760103+arunimshukla@users.noreply.github.com>
@rymnc

rymnc commented Oct 5, 2026

Copy link
Copy Markdown
Member

thank you @arunimshukla, merged in 3330621

@rymnc rymnc closed this Oct 5, 2026
rymnc pushed a commit that referenced this pull request Oct 27, 2026
Draft of the formal verification writeup, for review. It is unpublished
(`published: false`), so merging does not put it on the site; we flip
that on publication day.

The post walks one shielded pool from the written spec down to the
bytecode on Sepolia: what we proved at each layer, what we only checked,
what we still assume, what broke, and where this goes. One figure, in
the post's asset folder. The tables and footnotes carry the numbers;
every number traces to the model repository or the public pocs.

Read it as a reader would, then as a reviewer:

- Does the story hold together, and does it say anything stronger than
what we have?
- Is anything important missing, or given too much or too little room?
- Technical accuracy on the parts you know best. Corrections, pushback
and "this reads wrong" all welcome.

Not in this PR: the figure sources and the preview builder (they stay in
the notes vault), the spec mirror release, the model repository going
public, and the timelock merge, all of which sit on the pre-publication
checklist.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants