ethersphere / user-stories

Repository for maintaining user stories
5 stars 32 forks source link

[User-Story] Documentation - Go-client implementation #32

Open holisticode opened 5 years ago

holisticode commented 5 years ago

Rationale

If as a developer I want to contribute to the go-client implementation, I should be able to find all relevant documentation in one place. The documentation should include:

User-Story

As a go-client contributor I know where to find the documentation so that I am able to efficiently start contributing.

Epic links

Swarm Documentation #28

Acceptance criteria

I do not need any additional resource outside of the documentation. I do not need extensive on-boarding to contribute to the code.

Requirements

Proof

FantasticoFox commented 5 years ago

SWIP Process has been implemented (needs attention over the next weeks!) description and SWIPs found here. https://github.com/ethersphere/SWIPs - Daniel Nagy mainly in charge for protecting the process. Viktor and Me supporting to gather all content and create SWIP drafts to reduce backlog for SWARM.

The documentation in the swarm guide requires attention to create a cohesive picture how the different components which will be gathered in the SWIP play together. This requires restructuring of the current documentation.