Skip to content
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.

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

add validators pkg readme #1398

Merged
merged 14 commits into from
Dec 30, 2024
Merged

add validators pkg readme #1398

merged 14 commits into from
Dec 30, 2024

Conversation

ceyonur
Copy link
Collaborator

@ceyonur ceyonur commented Nov 26, 2024

Adds validators pkg readme

@ceyonur ceyonur requested review from darioush and a team as code owners November 26, 2024 17:25
Copy link
Collaborator

@meaghanfitzgerald meaghanfitzgerald left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestions are mostly for phrasing and grammar. It would be helpful if the read pointed to the places in Subnet-EVM where these functions exist, and provide example curls (or point to the ones in the docs site).

plugin/evm/validators/README.md Outdated Show resolved Hide resolved
plugin/evm/validators/README.md Outdated Show resolved Hide resolved
plugin/evm/validators/README.md Outdated Show resolved Hide resolved
plugin/evm/validators/README.md Outdated Show resolved Hide resolved
plugin/evm/validators/README.md Outdated Show resolved Hide resolved
plugin/evm/validators/README.md Outdated Show resolved Hide resolved
plugin/evm/validators/README.md Outdated Show resolved Hide resolved
plugin/evm/validators/README.md Outdated Show resolved Hide resolved
ceyonur and others added 4 commits November 27, 2024 17:55
Co-authored-by: Meaghan FitzGerald <meag.fitz@avalabs.org>
Signed-off-by: Ceyhun Onur <ceyhunonur54@gmail.com>
Co-authored-by: Meaghan FitzGerald <meag.fitz@avalabs.org>
Signed-off-by: Ceyhun Onur <ceyhunonur54@gmail.com>
Co-authored-by: Meaghan FitzGerald <meag.fitz@avalabs.org>
Signed-off-by: Ceyhun Onur <ceyhunonur54@gmail.com>
@ceyonur ceyonur enabled auto-merge (squash) November 27, 2024 16:12
Copy link
Contributor

@ARR4N ARR4N left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How much existing knowledge is a reader assumed to have? If non-negligible, where can they get that knowledge?

plugin/evm/validators/README.md Outdated Show resolved Hide resolved
plugin/evm/validators/README.md Outdated Show resolved Hide resolved
plugin/evm/validators/README.md Outdated Show resolved Hide resolved
@ceyonur
Copy link
Collaborator Author

ceyonur commented Dec 2, 2024

How much existing knowledge is a reader assumed to have? If non-negligible, where can they get that knowledge?

I also captured AvalancheGo's uptime manager basics in that readme, so we don't assume any existing knowledge. LMK if anyhing is not clear or you think it requires additional context.

darioush
darioush previously approved these changes Dec 17, 2024
Copy link
Collaborator

@darioush darioush left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some nits

plugin/evm/validators/README.md Outdated Show resolved Hide resolved
plugin/evm/validators/README.md Outdated Show resolved Hide resolved
plugin/evm/validators/README.md Outdated Show resolved Hide resolved
plugin/evm/validators/README.md Outdated Show resolved Hide resolved
Co-authored-by: Darioush Jalali <darioush.jalali@avalabs.org>
Signed-off-by: Ceyhun Onur <ceyhunonur54@gmail.com>
ceyonur and others added 6 commits December 30, 2024 21:05
Co-authored-by: Darioush Jalali <darioush.jalali@avalabs.org>
Signed-off-by: Ceyhun Onur <ceyhunonur54@gmail.com>
Co-authored-by: Darioush Jalali <darioush.jalali@avalabs.org>
Signed-off-by: Ceyhun Onur <ceyhunonur54@gmail.com>
Co-authored-by: Darioush Jalali <darioush.jalali@avalabs.org>
Signed-off-by: Ceyhun Onur <ceyhunonur54@gmail.com>
@ceyonur ceyonur merged commit e60bb75 into master Dec 30, 2024
14 checks passed
@ceyonur ceyonur deleted the add-uptime-readme branch December 30, 2024 21:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants