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

Improve Documentation #189

Closed
ruseinov opened this issue Nov 15, 2018 · 4 comments
Closed

Improve Documentation #189

ruseinov opened this issue Nov 15, 2018 · 4 comments

Comments

@ruseinov
Copy link
Contributor

We need to step up our documentation game as we're missing a lot of docs for some of the new extensions, like nft and others.

Need to revisit this, come up with a todo list and knock this out as this is crucial for adoption of the framework

@alpe @ethanfrey @husio @lehajam FYI

@alpe
Copy link
Contributor

alpe commented Nov 15, 2018

Can we refine this into actionable tasks?
For example we added functionality for payment channels and the base NFT type to weave. We also have a number of custom NFT types like username, blockchain, etc in early stage.
We can always improve docs and should probably include this into our main stories in the future.

@alpe alpe changed the title Documentation Improve Documentation Nov 15, 2018
@ruseinov
Copy link
Contributor Author

@alpe we have to refine this yes, but for that one needs to sit down what we do and don't have.
This is a placeholder ticket after a conversation with @ethanfrey who raised a fair point that it's almost impossible to figure anything out in our new undocumented modules without diving deep, especially if you are trying to integrate frontend and not a go dev

@ethanfrey
Copy link
Contributor

One clear actionable item is #187 for generating the various messages.

If comments in protobuf files (which also turn into go comment) could lead to docs, that would be very nice.

@ethanfrey
Copy link
Contributor

Vague issue. I am tackling this piece by piece.

Always happy for help

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

3 participants