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.

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

Initial sbtc docs update #1647

Merged
merged 22 commits into from
Oct 28, 2024
Merged

Initial sbtc docs update #1647

merged 22 commits into from
Oct 28, 2024

Conversation

kenrogers
Copy link
Collaborator

Update sBTC docs with new design

@kenrogers kenrogers requested a review from a team as a code owner October 4, 2024 16:26
@kenrogers kenrogers marked this pull request as draft October 4, 2024 16:29
@wileyj
Copy link
Contributor

wileyj commented Oct 4, 2024

One thing i'm nore sure about is the use of "sortitions" vs using "confirmations". is there a benefit to using one over the other?

@kenrogers kenrogers marked this pull request as ready for review October 7, 2024 20:34
wileyj
wileyj reviewed Oct 22, 2024
View reviewed changes
concepts/sbtc/README.md Outdated Show resolved Hide resolved
wileyj
wileyj reviewed Oct 22, 2024
View reviewed changes
concepts/sbtc/README.md Outdated Show resolved Hide resolved
wileyj
wileyj reviewed Oct 22, 2024
View reviewed changes
concepts/sbtc/README.md Outdated Show resolved Hide resolved
wileyj
wileyj reviewed Oct 22, 2024
View reviewed changes
concepts/sbtc/README.md Outdated Show resolved Hide resolved
wileyj
wileyj reviewed Oct 22, 2024
View reviewed changes
concepts/sbtc/README.md Outdated Show resolved Hide resolved
wileyj
wileyj reviewed Oct 22, 2024
View reviewed changes
concepts/sbtc/README.md Outdated Show resolved Hide resolved
wileyj
wileyj reviewed Oct 22, 2024
View reviewed changes
concepts/sbtc/README.md Outdated Show resolved Hide resolved
wileyj
wileyj reviewed Oct 22, 2024
View reviewed changes
concepts/sbtc/README.md Outdated Show resolved Hide resolved
wileyj
wileyj reviewed Oct 22, 2024
View reviewed changes
concepts/sbtc/README.md Outdated Show resolved Hide resolved
wileyj
wileyj reviewed Oct 22, 2024
View reviewed changes
concepts/sbtc/README.md Outdated Show resolved Hide resolved
wileyj
wileyj previously requested changes Oct 22, 2024
View reviewed changes
concepts/sbtc/clarity-contracts/README.md Outdated Show resolved Hide resolved
concepts/sbtc/clarity-contracts/README.md Outdated Show resolved Hide resolved
concepts/sbtc/clarity-contracts/sbtc-deposit.md Outdated Show resolved Hide resolved
concepts/sbtc/emily.md Outdated Show resolved Hide resolved
concepts/sbtc/operations/deposit-withdrawal-times.md Outdated Show resolved Hide resolved
concepts/sbtc/operations/deposit.md Show resolved Hide resolved
concepts/sbtc/peg-wallet-utxo.md Outdated Show resolved Hide resolved
@wileyj
Copy link
Contributor

wileyj commented Oct 22, 2024

Overall it looks really good - just a few minor requested changes and some minor nits to resolve

AshtonStephens
AshtonStephens approved these changes Oct 28, 2024
View reviewed changes
Copy link
Contributor

@AshtonStephens AshtonStephens left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LGTM!

While I'm sure there may be some small things that folks might get confused by, I suspect explaining it in more detail would be more confusing. We can adjust the docs if we get wind of confusion. So, 100/10 I think we hit the right balance of detail and explanation 🚀

@wileyj
Copy link
Contributor

wileyj commented Oct 28, 2024

I stil don't like the wording around "this entity" but i'll remove my review requesting changes for now so it's not a blocker.

kenrogers and others added 22 commits October 28, 2024 15:34
@kenrogers
Initial sbtc docs update
b640d8d
@kenrogers
Update structure and add some contract docs
8d730ca
@andrerserrano @kenrogers
Update core-features.md (#1649)
696400b
@andrerserrano @kenrogers
Update signer-wallet-rotation.md: removed "Bootstrap" (#1650)
a68a0a7
@andrerserrano @kenrogers
Update security-considerations.md (#1651)
8fae658
@kenrogers
Improve language and remove dynamic blocklist
a94cdb2
@kenrogers
Fix UTXO capitalization
223f8f1
@kenrogers
Update README
92cae2d
@kenrogers
Remove sbtc design folder
8a0834a
@kenrogers
Fix table of contents
cb1df7d
@kenrogers
Fix UTXO typo and remove key concepts page
69b14e1
@kenrogers
Remove line about future versions
e3f87a8
@kenrogers
Fix sidebar links
e8738e3
@kenrogers
Add API docs and walkthroughs
594b440
@kenrogers
Remove security considerations doc
6d6908f
@kenrogers
Update language to remove versions and bootstrap signers
fbe92eb
@kenrogers
Update sbtc pages
dc11c2b
@kenrogers
Minor clarifications and rewrites
9468678
@kenrogers @wileyj
Fix typo
ba7c8e4 
Co-authored-by: wileyj <2847772+wileyj@users.noreply.github.com>
@kenrogers @wileyj
Fix typo
020c584 
Co-authored-by: wileyj <2847772+wileyj@users.noreply.github.com>
@kenrogers @wileyj
Minor text edit
7bb8578 
Co-authored-by: wileyj <2847772+wileyj@users.noreply.github.com>
@kenrogers
Clarify language
46ae275
@kenrogers kenrogers merged commit 593adce into master Oct 28, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@marthaadrienne marthaadrienne marthaadrienne left review comments

@wileyj wileyj wileyj left review comments

@andrerserrano andrerserrano andrerserrano approved these changes

@AshtonStephens AshtonStephens AshtonStephens approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@kenrogers @wileyj @AshtonStephens @andrerserrano @marthaadrienne