Skip to content

docs: add a short glossary of ZK/Stellar terms for new contributors #31

Description

@tech-adrian

Area
repo root or docs/

Problem
DESIGN.md and README.md use terms like nullifier, commitment, Merkle root, UltraHonk, keccak transform, and Poseidon2 throughout, assuming ZK familiarity. This raises the bar for new contributors who understand Stellar/Soroban but not zero-knowledge cryptography, or vice versa.

Proposed change
Add a short GLOSSARY.md defining the ~15 most-used domain terms in the codebase in one or two plain-English sentences each, linked from README/CONTRIBUTING.

Acceptance Criteria

  • GLOSSARY.md covers the core terms used across README/DESIGN.md (nullifier, commitment, Merkle root, recipient binding, UltraHonk, Poseidon2, selective disclosure, relayer, etc.)
  • Linked from README.md and/or CONTRIBUTING.md
  • Relevant tests (just test, pnpm test, cargo test, or nargo test as applicable) pass locally and in CI
  • A screenshot or short screen recording is attached to the PR showing the change working (the rendered glossary) — required before this can be merged.

Open your PR against the dev branch, not main. All active development merges into dev.

Discuss this issue / coordinate work: join the DShield contributor Telegram group: https://t.me/+SiGHH24No9U2MDJk

Metadata

Metadata

Assignees

Labels

GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial Campaign | FWC26Campaign: Official Campaign | FWC26documentationImprovements or additions to documentationgood first issueGood for newcomers

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions