secretfoundation / dev_committee Goto Github PK

This can potentially be 2 posts - 1 as a developer tutorial and the other more like a solution series post

Technical post should build on the readme (https://github.com/baedrik/SCRT-sealed-bid-auction/blob/master/WALKTHROUGH.md) and just have a quick introduction / conclusion

Non-technical post (Can can lead this)

• why secretAuctions are important
• secret contract walkthru link (to the post above)
• business applications that can be built with secretAuctions

Right now there is seemingly no documentation on secretJS. It would be helpful for those trying to interact with deployed contracts to have robust documentation around this.

Keep a list of all ecosystem projects with relevant descriptions / logos and link etc.

This can also be an easy way to populate information for the ecosystem page on scrt.network

Creating the documentation content for SecretSwap

An area to explore is to look into CosmWasm documentation and adapt their documentation to SN to have:
i) more detailed documentation on how secret contracts work (besides create and deploy)
ii) Architecture of a secret app

Update technical resource index for Secret Network
https://blog.enigma.co/enigma-technical-resource-index-bd9110714ea6

I've created a draft here: https://blog.scrt.network/ghost/#/editor/post/5f9c68963377fb06183e8b37

I've submitted PRs to update the testnet docs. As soon as those are approved and merged, the article is good to go (assuming no changes are needed from review).

scrtlabs/SecretNetwork#650

Goal is to improve the organization of information and add additional info to create a comprehensive secret contract guide

I think we need to add the following / create sections so the information is easily accessible. The read me can then act as an index.

Getting setup (probably simpler to add a md on this and link to it:

• migrate testnet info to a new md (on-hold for now)

Setup secret contracts

• new md file (section) (on-hold for now)

Build your initial simple secret contract

• use Assaf's simple voting contract (https://github.com/enigmampc/SecretSimpleVote/blob/master/src/contract.rs)
• improve read.me to explain the contract line by line. The end goal I have in mind is something similar to Adi's voting contract walkthru for Discovery (https://blog.enigma.co/getting-started-with-enigma-an-intro-to-secret-contracts-cdba4fe501c2)

link to the secretToolkit

• explain what the toolkit does and links to the actual contract
• add a md file for actions that devs will need to re-use a lot, like calling another contract from a secret contract (@baedrik)

build an advanced secret contract( new md.) ->

• we add Baedrick’s auction walkthrou and code here

build a UI using Secret.JS ->

• new md. file
• Keplr integration (simple integration and advanced information on how to handle transactions, error reporting, waiting etc.)

Deploy it on testnet and miannet

• add holodeck info to the new md cc @lauraweindorf
• add information to deploy it on mainnet

• Whiteboard on what the developer page should include @cankisagun
• Share it with the development committee / Sandy

Current state of roadmap is a review of past accomplishments, should be updated to reflect future goals.

https://github.com/enigmampc/SecretNetwork/blob/master/docs/protocol/roadmap.md

We need to find a way to allow edits (linking to github for PRs) on build.scrt.network?

Is our documentation site best in class?

• secret auction
• secret voting
  See if there are improvement areas in the documentation or readme of these repo's compared to Discovery Salad

Details can be found here https://github.com/baedrik/SCRT-sealed-bid-auction/issues

Deploy developer contribution reputations based on SecretNetwork repo contribution.

Currently we are rewarding PRs. We will collect contributor addresses over issues. Taariq thinks we can do a gist (https://gist.github.com/)

Secret Network documentation is fragmented (build / learn) resulting in a sub-optimal experience for developers and general public trying to learn more about the project.

This project will require a couple of steps:

1. Benchmark analysis: Compare the content / categorization of content between Secret Network and other L1s like Near, Cosmos and Terra. The questions we want to answer are:

• Are we missing any content
• Can we better organize our content

The outcome of this effort should be a thorough analysis on:

• how other projects store information on their documentation site
• do we have that information in our docs (if so where / if not is it relevant for us and should we add it)
• recommended structure of docs for secret network (combining learn and build)

2. Update documentation based on benchmarking analysis and recommendations - we are open to changing docs providers

3. Fix all previous links and dependencies

Update https://build.scrt.network/ content / go over all the tabs to looks for:

• working links (if they point to the right place. For example last week I just changed rocketchat links to discord)
• informational inconsistencies (like talking about secret contracts don't exist yet and we are using CosmWasm)
• potentially missing information that you'd like to see

You can skip developers - > quick start guide. We are working on this repo separately

• Index - https://github.com/enigmampc/SecretNetwork/blob/master/docs/.vuepress/config.js
• Docs - https://github.com/enigmampc/SecretNetwork/tree/master/docs

Link the guide to build -> devs -> Quickstart

Let's rename "quick start" to "walkthrough"

documentation on secretNetwork repo (enigma github)

WIP based on PoolTogether UI with Sandy and Victor
Can recently provided feedback on the UI