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

Documentation Revamp - [ Secret network overview ] #130

Closed
1 of 5 tasks
ertemann opened this issue May 2, 2022 · 12 comments
Closed
1 of 5 tasks

Documentation Revamp - [ Secret network overview ] #130

ertemann opened this issue May 2, 2022 · 12 comments

Comments

@ertemann
Copy link
Collaborator

ertemann commented May 2, 2022

Secret network overview chapter of Docs.scrt.network , link issues for separate headers.

This section should contain 0 code and not reference community resources as explanation but have the full explanation written out.
For people to develop on SN they need to know what the core concepts are it uses.

Structure:

  • What is Secret Network?
    • History / backstory of Secret Network
      - SN ethos
      - privacy in web3 vs web2
      - Enigma MPC --> SN SGX
      - timeline of launches
    • Tech overview
      • SGX + sdk (short) - Assigned to TripleA** -- Started
      • what is SCRT / sSCRT? - Assigned to TripleA -- DONE
    • SN use cases -- DONE
    • Roadmap
    • Socials - website
  • Blockchain technology - Assigned to Kharnhash -- Started
    • The Cosmos basics
      - Tendermint core
      - Dpos/BFT
      - governance
      • SDK and ABCI
      • IBC
      • CosmWasm module
    • Network architecture
      - Validators, mempool, chain interaction
  • Privacy technology
    • remote attestation
    • bootstrap/seed node
    • Encrypted transaction
      - user side encryption --> mempool --> full node SGX --> State change --> Viewing key to show
    • inputs/outputs
      • how it’s made
      • how to use
    • storage
    • Viewing keys/Permits
    • Privacy Roadmap (HME)
    • comparisons - Assigned to Ertemann -- Started
      • monero/zcash
      • phala/oasis?
      • aleo/dero/sero
      • penumbra/nym
      • dusk
    • Trust assumptions
      • SGX
      • Admin key
      • bridge (eth/bsc/monero)
      • IBC
@ertemann ertemann changed the title Doc Revamp - [ Secret network overview ] Documentation Revamp - [ Secret network overview ] May 2, 2022
@3ppleA
Copy link

3ppleA commented May 3, 2022

Hi.
I would like to take up the project under the header " What is Secret Network".
Kindly help me with brief description of the project and what is expected.

Regards.

@ertemann
Copy link
Collaborator Author

ertemann commented May 6, 2022

hey @3ppleA , every subheader is meant as 1 project. Would the what is SCRT/sSCRT part work for you?

  • Talk about why SCRT exists and what it utillities are for Secret network.
  • Talk about the Snip-20 Standard
  • Give example of sSCRT as the snip-20 and what utillity this gives. (semi-transactional privacy, private interactions with smart contracts etc).

@3ppleA
Copy link

3ppleA commented May 6, 2022

Alright.
Thanks.

Where should I push the new content please? Google doc?

@ertemann
Copy link
Collaborator Author

ertemann commented May 6, 2022

Hey @3ppleA

It would be preffered if you could work with Github and markdown ( .MD) files, i am happy to help. That way it is also documented on the Git that you added this section. If this is a bit to difficult you can also work in Google docs and I can push the content to Github for you.
We will work with markdown files only (.MD) You can edit/create those in Notepad ++ (https://notepad-plus-plus.org/downloads/) if you are using windows.

You can Fork this repository to your own github. Create a new branch there based of off the docs_revamp branch. Then you can work on it and Make a merge request to the doc_revamp bridge on here when you are done. If this does not suit you you can also just create a .MD file and we can add it for you.

Just let me know if you have questions.

@3ppleA
Copy link

3ppleA commented May 6, 2022

Hello @ertemann ,

I would prefer to work in Google docs to make the work pretty easier and faster. I'm not really familiar with GitHub and markdown ( .MD) files.

Is there any word limit for each subheader please?

Thanks.

@ertemann
Copy link
Collaborator Author

ertemann commented May 9, 2022

hey @3ppleA that is fine, you can sent me the document in Discord Dms when you are done and i will publish it. there is no word limit but it should be as short as possible with as much information as possible. no need to make it longer then necessary

@3ppleA
Copy link

3ppleA commented May 9, 2022

Alright then.

Thanks

@intellygentle
Copy link

intellygentle commented May 9, 2022

Secret network overview chapter of Docs.scrt.network , link issues for separate headers.

This section should contain 0 code and not reference community resources as explanation but have the full explanation written out. For people to develop on SN they need to know what the core concepts are it uses.

Structure:

  • What is Secret Network?

    • History / backstory of Secret Network

      • SN ethos
      • privacy in web3 vs web2
      • Enigma MPC --> SN SGX
      • timeline of launches
    • Tech overview

      • SGX + sdk (short)
      • what is SCRT / sSCRT?
    • SN use cases

    • Roadmap

    • Socials - website

  • Blockchain technology

    • The Cosmos basics

      • Tendermint core
      • Dpos/BFT
      • governance
      • SDK and ABCI
      • IBC
      • CosmWasm module
    • Network architecture

      • Validators, mempool, chain interaction
  • Privacy technology

    • remote attestation

    • bootstrap/seed node

    • Encrypted transaction

      • user side encryption --> mempool --> full node SGX --> State change --> Viewing key to show
    • inputs/outputs

      • how it’s made
      • how to use
    • storage

    • Viewing keys/Permits

    • Privacy Roadmap (HME)

    • comparisons

      • monero/zcash
      • phala/oasis?
      • aleo/dero/sero
      • penumbra/nym
      • dusk
    • Trust assumptions

      • SGX
      • Admin key
      • bridge (eth/bsc/monero)
      • IBC

Hi! I'll take Blockchain technology

@ertemann
Copy link
Collaborator Author

@intellygentle like mentioned above the idea is you take a subheader. the education committee team is already working on the entirety of the header you mention here.

@intellygentle
Copy link

I suppose the network architecture is a subheader, if not, suggest me the subheaders so that I can choose.

@ertemann
Copy link
Collaborator Author

@intellygentle that entire header is taken,

You can look at any of the things in Privacy technology ?

@intellygentle
Copy link

Yeah! I should be good at Viewing keys/permits documentation.

@norfmenn norfmenn closed this as completed Aug 9, 2022
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

4 participants