Add docs on what exact validation vtvalidate does
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 15
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Description
vtvalidate currently will throw (or provide an error message) if vtzero (the decoder used in vtvalidate) cannot decode a message. This needs to be documented so users of vtvalidate do not need to hunt into the vtzero code to know exactly what validation is being performed.
This doc should be a living doc, per version, as we (potentially) add more validation over time.
refs:
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 with the referenced vtzero-check.cpp example and vtzero issue #23 to understand the decoder behavior that vtvalidate exposes. Document the validation performed by vtzero, including thrown errors or messages, in a living document organized by version. Done means vtvalidate users can determine the exact validation without reading vtzero code.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100