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

Address stale docs highlighted in OBO-17 #2956

Open
OisinKyne opened this issue Mar 11, 2024 · 0 comments
Open

Address stale docs highlighted in OBO-17 #2956

OisinKyne opened this issue Mar 11, 2024 · 0 comments
Labels
protocol Protocol Team tickets

Comments

@OisinKyne
Copy link
Contributor

🐞 Bug Report

Description

We reference a component that doesn't exist here. https://github.com/ObolNetwork/charon/blob/v0.18.0/docs/architecture.md#signer

It should likely be removed.

In docs/architecture.md , the architecture overview diagram mentions an internal Signer component that is responsible for
interacting with the external Remote Signer component. However, this internal Signer component does not exist in the codebase. In the
section Stitching the core workflow of the documentation, it also mentions that the Signer.sign function is subscribed to the
consensus client. However, this is not shown in core/interface.go , the file that wires the core workflow together.

Has this worked before in a previous version?

N/A

@github-actions github-actions bot added the protocol Protocol Team tickets label Mar 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
protocol Protocol Team tickets
Projects
None yet
Development

No branches or pull requests

1 participant