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

Verify all "latest" docs are up to date #808

Open
ethanfrey opened this issue Jun 25, 2019 · 0 comments
Open

Verify all "latest" docs are up to date #808

ethanfrey opened this issue Jun 25, 2019 · 0 comments
Labels
bug A functionality that was delivered is no longer working as expected. docs Time to write some documentation

Comments

@ethanfrey
Copy link
Contributor

ethanfrey commented Jun 25, 2019

Expected Behavior

Issue #807 among others shows that readthedocs are actually being used 🎉 This also means that we need to complete the half-done update. We expect someone to follow through the docs and everything just working.

Actual Behavior

Lots of out-dated build instructions. Theory is there, but code steps are wrong.

Additional info

Please go through all items in the side bar (linked from index.rst, we can ignore index_old.rst for now as it is old). Try out all code samples and correct anything that doesn't work. Also update any references from mycoind to bnsd as the sample app in weave. All references to the deleted examples/tutorial should now direct to https://github.com/iov-one/tutorial.

In addition, the docs/mycoind directory with all installation instructions should be renamed (and likely rewritten)

Actual instructions on how to use the API are outdated as well, but not yet linked from index.rst, that is another issue

@ethanfrey ethanfrey added bug A functionality that was delivered is no longer working as expected. docs Time to write some documentation labels Jun 25, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug A functionality that was delivered is no longer working as expected. docs Time to write some documentation
Projects
None yet
Development

No branches or pull requests

1 participant