-
Notifications
You must be signed in to change notification settings - Fork 3.8k
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
Refactor Docs #1289
Refactor Docs #1289
Conversation
Codecov Report
@@ Coverage Diff @@
## develop #1289 +/- ##
========================================
Coverage 65.61% 65.61%
========================================
Files 103 103
Lines 5572 5572
========================================
Hits 3656 3656
Misses 1713 1713
Partials 203 203 |
Ok so, there's really a lot to do here to make these docs properly, and I think some of that has to do with reorganizing the code along the lines of #976 . We should also try to make as much use of the GoDoc as possible so we're not always copying definitions everywhere, but we probably need to improve the package structure to do that. So I'm going to stop here and we should have a meeting to discuss how best to lay out the documentation and a strategy for getting it written ... |
ac2903d
to
105d064
Compare
Discussed this with @AdityaSripal @jlandrews and @jolesbi and made some minor changes based on that. The basic idea for explaining the core is as follows:
By now we have a full basecoin, but there's still more to explain. For the advanced section, we can maybe use demo coin, or just point to gaia. |
what's the status on this PR? |
Just rebased on develop. Let's merge when tests pass and pick up from there |
This is the start of a reorg to the docs. Some notable points