Write Readme and API documentation for packages - Githubissues

Consensys / web3studio-soy

Static Websites on the Distributed Web

https://medium.com/web3studio/soy-is-the-secret-sauce-for-the-unstoppable-web-6e2c1f37430b

33 stars 5 forks source link

Write Readme and API documentation for packages #34

Closed barlock closed 5 years ago

barlock commented 5 years ago

Overview

As a developer-user of soy, I want to understand the higher level purpose and how to use the project, as well as how to use the underlying projects.

Assumptions

Overview of all projects should be in a top level readme
API documentation should be generated from jsdoc
jsdoc should be generated as commit hook

Acceptance

Developers have the tools they need to understand how to use a project
Developers know the background of and how to use Soy as a whole

Tasks

[ ] Write top level documents
[ ] Generate underlying api documents