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

Update sBTC Documentation #569

Open
andrerserrano opened this issue Sep 25, 2024 · 0 comments
Open

Update sBTC Documentation #569

andrerserrano opened this issue Sep 25, 2024 · 0 comments
Assignees

Comments

@andrerserrano
Copy link

andrerserrano commented Sep 25, 2024

This milestone focuses on delivering comprehensive documentation for the sBTC protocol, with a particular emphasis on ensuring that signers, developers, and users have the resources they need to successfully interact with and understand the system.

1) Signer documentation includes:
Detailed step-by-step guides, API references, and architectural diagrams explaining how signers operate within the sBTC protocol. This includes:

  • Overview of the signer's responsibilities and roles in securing the protocol
  • Setup and onboarding procedures for new signers
  • Explanation of the signer architecture and security best practices
  • Detailed troubleshooting section for resolving common issues.

2) Developer-Focused Documentation:
A technical manual aimed at developers who want to interact with the sBTC protocol or contribute to its growth. This includes:

  • API documentation for integration with the sBTC protocol.
  • Code examples and use cases for interacting with the smart contracts.
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

No branches or pull requests

2 participants