docs's People
docs's Issues
Review texts for new onboarding flow
What to do?
Right now we are working on the new onboarding to make it simpler and more convenient for a user. We tried to describe all the interim steps that he is passing during the onboarding.
So, we need to review texts to fix grammatical and syntax mistakes.
Feel free to answer any questions, I'll answer as soon as possible
You can find the flow here
[Doc] How is TRM work?
What to do?
Add a section to docs where we describe what is TRM and how it works
More about TRM user flow you can take a look here - https://www.figma.com/file/bXyJludNXAUF3qDjysIDd4/%5BzkBob%5D-TRM-Integration?node-id=0%3A1
zkBob diagrams
These are the diagrams needed for zkBob. Most are revamps of current diagrams, several should be created from the steps. Let me know your thoughts on these. Thanks!
Revamp Existing Diagram:
Smart Contracts: https://poa.gitbook.io/zkbob/implementation/contracts-and-circuits
Trusted Ceremony:
https://poa.gitbook.io/zkbob/deploying-zkbob/zkbob-solution-deployment
Transaction Types:
https://poa.gitbook.io/zkbob/implementation/transaction-overview/transaction-types
Transaction Lifecycle:
https://poa.gitbook.io/zkbob/implementation/transaction-overview/the-transaction-lifecycle
Round Robin Operation:
https://poa.gitbook.io/zkbob/implementation/contracts-and-circuits/operator-manager-contract/round-robin-operator-manager
No Diagram Created Yet:
Implementation steps for trusted ceremony:
https://poa.gitbook.io/zkbob/deploying-zkbob/zkbob-solution-deployment/trusted-setup-ceremony#contribution-guide-and-implementation-details
Technical Documentation
- Add user flow descriptions (waiting for the UI)
zkBob_usecaseexamples
For zkBob wondering about creating a few other graphics related to use cases. We have this private transfer use case and will also create a salary one. Is it enough info to create a flow diagram?
https://docs.zkbob.com/zkbob-overview/basic-concepts/use-case-example
Could create several diagrams as well - one for each action or combine a few? Not sure what would look best.
Example of other zkBob illustrations:
https://docs.zkbob.com/implementation/contracts-and-circuits
https://docs.zkbob.com/implementation/transaction-overview/transaction-types
https://docs.zkbob.com/implementation/transaction-overview/the-transaction-lifecycle
Assign to Outcrowd
DESIGN: zk Illustrations "Use Case Examples"
Create 2 illustration for
https://docs.zkbob.com/zkbob-overview/basic-concepts/use-case-examples
Assign to outcrowd. Paid
DESIGN: zk Illustrations "your friend and guide to transact in private"
Andrew Gross
No, currently there are 8 requested images, each in the form of a comment in the doc.
Most (6) are in cartoon format -Alice and zkBob talking to each other with dialogue bubbles. The remaining 2 are visualizations of topics described in the document.
Add <ZH-CN> localization to the zkBob app.
zkbob chineses translation.json
Adding Simplified Chinese translation here for zkBob
zkDoc: Create PDF "Your friend and guide to transact in private"
Create PDF template:
- A4 format
- Illustrations
Review texts for the TRM alert
@andogro could you please review the text for the alert that we show a user if we found that his wallet suspicious?
Also, my suggestion is to add the link to this popup that will redirect a user to the page where we can describe in a few sentences what's mean that a wallet is suspicious
Relates to this task:
[Doc] How is the multitransfer work?
What to do?
Add a section to docs where we describe what is Multitransfer and how it works
More about TRM user flow you can take a look here - https://www.figma.com/file/CKh07gYkHCkQS424wNDsO7/%5BzkBob%5D-Multi-send?node-id=0%3A1
[Doc] Add info about UAE restrictions
What to do?
We need to create a page in the documentation where we will describe why we closed access to zkBob in a specific country
For now, we need to add information about UAE based on the following news: https://www.coindesk.com/policy/2023/02/08/dubai-prohibits-privacy-coins-under-new-crypto-rules/
We will use this link for the message on UI for users who will open zkBob from restricted countries
@andogro tag me please when the page will be ready
btw, we can add this information to the following page
Ceremony for the release deploy
Need to define network params for the release
(Eugene)
Q: do we need to audit the ceremony script?
Add <RU> localization to the zkBob app.
RU tranlation for zkBob app
translation ru.json
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. ๐๐๐
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google โค๏ธ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.