Skip to content

fix: preserve continuation-line glossary definitions - #1

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

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

Conversation

@arunimshukla

@arunimshukla arunimshukla commented Sep 25, 2026 •

Copy link
Copy Markdown
Owner

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 upstream ethsystems#45 is now present on main through commit 63f99bd. This branch is rebased onto that commit and contains only this follow-up.

Reproduction

Against current upstream 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

@arunimshukla
arunimshukla marked this pull request as ready for review September 28, 2026 17:53
@arunimshukla
arunimshukla force-pushed the fix/multiline-glossary-definitions branch from 7f83f5c to 0cce2a5 Compare September 28, 2026 18:10
@arunimshukla arunimshukla changed the title fix: preserve multiline glossary definitions fix: preserve continuation-line glossary definitions Sep 28, 2026
@arunimshukla
arunimshukla changed the base branch from fix/glossary-links to main September 28, 2026 18:11
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.

1 participant