[S2S]: Improve introduction and overview section
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 125
- Forks
- 41
- PR merge metrics
- No merged PRs in 30d
Description
This issue is tracking improving the introduction and overview section to make it more understandable as to the purpose, goals and framework of the S2S specification.
The updated version should be structured something like:
- Premise of why we want Wallets (Privacy)
- Premise of why we want Wallet Servers (Scaling, Performance, Lifecycle, Security, Maintenance)
- Goal of spec is to support the second without compromising the first
- Introduce core mechanism for doing this (authenticated encrypted channel to/from the Wallet app)
After that, continue with an overview of the phases, breaking down the purpose, state before, state after, examples and linking out to the sections for more details.
This is serving as the issuer for all editorial changes in the overview section from the initial PR.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the S2S specification's introduction and overview section, then review the existing phase overview and the initial PR referenced in the issue. Done means the section clearly explains the privacy and wallet-server premises, the specification's goal, the authenticated encrypted channel, and each phase's purpose, states, examples, and links.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100