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

Adding signer product requirements #69

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

andrerserrano
Copy link
Collaborator

Added signer requirements and user stories to documentation

@andrerserrano andrerserrano linked an issue Aug 15, 2023 that may be closed by this pull request
Copy link
Contributor

@netrome netrome left a comment

Choose a reason for hiding this comment

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

Although I like the idea of moving more information to these docs, I'm not sure if this document would make sense for a reader who is not already involved in the project.

We should either provide more context around the document, to explain what the signer SDK is and who these requirements are directed at. Optionally, we could create an appendix section in SUMMARY.md where we may add docs like this one.

Comment on lines +3 to +4
- [Technical Specifications Document](https://github.com/stacks-network/stacks/blob/master/sBTC/sbtc_technical.md)
- [Product Requirements Document](https://github.com/stacks-network/stacks/blob/master/sBTC/sbtc_product.md)
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not a fan of linking to this repository here. The TSD can be omitted, since all information is already present in these docs. The product requirements doc could be incorporated, and I see you've already created a placeholder file fore it.

@friedger friedger changed the base branch from master to main October 27, 2023 20:48
@CLAassistant
Copy link

CLAassistant commented Nov 16, 2023

CLA assistant check
All committers have signed the CLA.

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.

Add docs for sBTC Signer user stories
3 participants