base / base/blob-archiver

docs(readme): validator component is not documented

Open Beginner friendly
#64 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
126
Forks
87
PR merge metrics
No merged PRs in 30d

Description

The repository has three components — Archiver, API, and Validator — but the README only documents the first two. The validator is built by 'make build' and has tests, but there is no mention of what it does, how to run it, or what configuration options it accepts. Running 'go run validator/cmd/main.go --help' shows it checks blob validity against a beacon node and blob API.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the README and validator/cmd/main.go; run `make build` and `go run validator/cmd/main.go --help` to inspect the validator's behavior and configuration options. Document what the validator does, how to run it, and the accepted configuration, then verify the README accurately matches the command and existing tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.