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

Update readthedocs to weave 0.12 #280

Closed
ethanfrey opened this issue Jan 21, 2019 · 0 comments
Closed

Update readthedocs to weave 0.12 #280

ethanfrey opened this issue Jan 21, 2019 · 0 comments
Assignees

Comments

@ethanfrey
Copy link
Contributor

ethanfrey commented Jan 21, 2019

https://weave.readthedocs.io/en/latest/index.html is generated from https://github.com/iov-one/weave/tree/master/docs (always master).

The information there is mostly correct, but somewhat out of date. Please go through, try all commands, and update them to work with weave 0.12. Then add a big note at the top that this works with weave 0.12 (so we see a problem when weave is at 0.14 and we still haven't updated them).

You can gladly make some changes, like using bcpd instead of mycoin as the demo app. You may want to update the Makefile as well, so it is easier to install.

This is not about improving the docs, but rather updating them.

All code for the javascript/typescript client (iov-core) can be removed and replaced by a link to the docs on that repo, which are more guaranteed to be kept up to date. This means mycoin tutorial can be removed, and requirements/installation moved to deployment.

@ethanfrey ethanfrey self-assigned this Feb 11, 2019
@ethanfrey ethanfrey changed the title Update readthedocs to weave 0.10 Update readthedocs to weave 0.12 Mar 5, 2019
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

1 participant