Skip to content

fix: preserve glossary links - #45

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

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

Conversation

@arunimshukla

Copy link
Copy Markdown
Contributor

Summary

I fixed glossary links that were being stripped during generation or rendered as literal Markdown on the glossary page.

The change:

  • preserves URLs attached to linked glossary term names
  • renders links inside glossary definitions
  • rewrites internal map links to their site routes
  • routes root map documents such as CONTRIBUTING.md to their GitHub source
  • regenerates the glossary data with preserved link metadata
  • adds regression coverage for linked terms, external references and internal glossary links

This fixes cases including ERC-3643, RFC 9497, the Attestation pattern reference and the CROPS contribution reference.

Validation

I validated the change locally with:

  • npm run build:graph
  • npm test
  • npm run build
  • npm run check
  • git diff --check

Results:

  • 154 graph nodes generated
  • 74 glossary terms generated
  • 58/58 tests passed
  • 218 pages built successfully
  • no whitespace errors
  • generated glossary output contains the expected external and internal links

astro check continues to report the repository's existing diagnostics; this change does not introduce diagnostics in the modified glossary files.

rymnc pushed a commit that referenced this pull request Sep 28, 2026
Cherry-pick of
[#45](#45) into this
repo.

## Summary

* preserve URLs on linked glossary term names in `parseGlossary` and add
an optional `href` to glossary entries
* render glossary definitions through `inlineMd` so links in definitions
render instead of showing literal Markdown
* route root map docs (`README`, `CONTRIBUTING`, `CHANGELOG`,
`GLOSSARY`) to their GitHub source in `resolveHref`
* regenerate `src/data/glossary.json` with the preserved hrefs; add
regression tests

## Verification

* applied via `git am` from the upstream patch, so original authorship
(`Arunim Shukla`) is preserved on the commit
* patch applied cleanly against `web-private@main` (e6de848) with no
conflicts
* `npm run build:graph`: 154 nodes, 74 terms; regenerated
`glossary.json` is identical to the committed one
* `npm test`: 58/58 passed
* `npm run build`: 218 pages built

Upstream author: @arunimshukla
Prompted by: ac

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

rymnc commented Sep 28, 2026

Copy link
Copy Markdown
Member

thank you @arunimshukla, merged in 63f99bd

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