Proc macro: struct explanation to improve help
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1.9k
- Forks
- 454
- Avg merge
- 3d 22h
- Merged PRs (30d)
- 35
Description
Currently, the kinds of information that can be retrieved from running diskann-benchmarks inputs <some input name> are pretty limited to a JSON schema with no documentation. As inputs start to get richer, a more comprehensive explorer for accepted JSONs (with documentation pulled from the struct docs) would be super helpful.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by running diskann-benchmarks inputs <some input name> and inspect how its JSON schema is produced from the input structs and proc macro. Trace where struct documentation could be surfaced in the explorer. Done means the command provides a more comprehensive view of accepted JSON inputs with documentation pulled from the struct docs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- cli, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100