mirror of
https://github.com/OffchainLabs/prysm.git
synced 2026-02-03 01:25:33 -05:00
571c6f39aa
**What type of PR is this?** Documentation **What does this PR do? Why is it needed?** Although godoc and comments are well-written in `encoding/ssz/query` package, we (@rkapka, @fernantho, @syjn99) [agreed](https://discord.com/channels/476244492043812875/1387734369527136297/1466075406523174944) that it would be great to have human-readable documentation. **Which issues(s) does this PR fix?** Part of #15587 & #15598 **Other notes for review** This documentation is first drafted by Claude Code, and then has a few rounds of self-review. **Acknowledgements** - [x] I have read [CONTRIBUTING.md](https://github.com/prysmaticlabs/prysm/blob/develop/CONTRIBUTING.md). - [x] I have included a uniquely named [changelog fragment file](https://github.com/prysmaticlabs/prysm/blob/develop/CONTRIBUTING.md#maintaining-changelogmd). - [x] I have added a description with sufficient context for reviewers to understand this PR. - [ ] I have tested that my changes work as expected and I added a testing plan to the PR description (if applicable). --------- Co-authored-by: fernantho <fernantho1@gmail.com> Co-authored-by: Radosław Kapka <radoslaw.kapka@gmail.com>