search

near / devrel

The space for DevRel
MIT License
9 stars 0 forks source link

[DEVREL RESOURCE REQUEST] #184

Open Kisgus opened 3 years ago

Kisgus commented 3 years ago

Proposal for assistance with Sputnik DAO v2 contract documentation

What is this?

Core contracts for Sputnik DAO v2 framework

Who needs to be involved?

A talented technical writer, we have a dev that can help with questions who looked deep into this for 1-2 weeks already

When do you need this work completed by

The Gitcoin Open Web NEAR hackathon starts in 1 week and 1 day from now. It would awesome to have well documented contracts by then so all the hackers can use these to hack on for the hackathon and help iterate the contract and the documentation

Tasks to complete (can return to [x] these)

What t-shirt size is this? (range: multi-sprint to 1 hour)

Small

What priority is this? (remove what doesn't apply)

I consider this P1 for getting most out of the Gitcoin hackathon

amgando commented 3 years ago

Gitbook is fine for docs.

I would recommend that we start with some structure, like an outline, then split up the work of each part.

Someone should play editor to review all the content and make it sound like one voice.

Here's a quick draft of an outline. We should definitely have some organizing structure to start with and this is just one idea. Maybe others can also suggest ideas that we can discuss in the kickoff meeting and agree on one outline to start working on

ORIENTATION

(can be 90% links to other content already online like YouTube, etc with 500 new words)

SPUTNIKDAO v1

(can be very simply intro, maybe 500-1000 new words max)

SPUTNIKDAO v2

DAO TOKEN

DAO GROUPS

DAO POLICIES

DAO BOUNTIES

DAO UPGRADES

DAO COMMAND REFERENCE

DAO SOURCE CODE

DAO IN THE WILD

amgando commented 3 years ago

https://meet.google.com/sgw-gxii-jib

Kickoff meeting scheduled for Monday, May 10 @ 6-7pm GMT+3

starpause commented 3 years ago

Goals for this week (3-4 days):

Long term goals:

Workflow:

nearlyalmonds commented 3 years ago

Also available for editorial review if helpful to Josh/Sherif.

thisisjoshford commented 3 years ago

Documentation progress is currently blocked as we wait for Sputnik DAO PR #11 merger that will alter contract functionality. According to DenysK, this will take place sometime tomorrow (5/13/21).

thisisjoshford commented 3 years ago

UPDATE: DenysK will be updating the README with basic create/deploy/call commands for Sputnik DAO v2 after PR has been reviewed and merged (hopefully tomorrow 5/13/21). He will then review the contracts and their functionality advising @amgando and myself of what he would like us to have documented by next Friday (5/21/21).

thisisjoshford commented 3 years ago

UPDATE: PR #11 has been merged and DenysK is now testing functionality and creating a list near-cli commands that @amgando and I will document. Waiting for his green light to start this process.