New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Investigate and implement tooling to ensure README files are accurate across all packages #2828

Closed

3xtr4t3rr3str14l opened this issue Jul 9, 2021 · 1 comment · Fixed by #2841

Assignees

Contributor

3xtr4t3rr3str14l commented Jul 9, 2021

Do this for all lodestar-relevant codebases (i.e. all inside monorepo as well as externals that are related such as ssz, bls-*, etc).

Would be great to have tooling to ensure the readme is up to date. I think rust has something like that to ensure code snippets compile

from:
https://discord.com/channels/593655374469660673/605818244036821012/862719541838348318

Contributor

dapplion commented Jul 12, 2021

This tool looks promising https://github.com/bbc/typescript-docs-verifier

dapplion assigned 3xtr4t3rr3str14l

This was referenced Jul 14, 2021

README checks #2841

Merged

Consistent package configuration on Lodestar libs #2459

Open

wemeetagain closed this as completed in #2841

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment