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

Refactor Docs #1289

Merged
merged 13 commits into from
Jun 21, 2018
Merged

Refactor Docs #1289

merged 13 commits into from
Jun 21, 2018

Conversation

ebuchman
Copy link
Member

This is the start of a reorg to the docs. Some notable points

  • Gut the README so its more accessible
  • Start building cohesive documentation under /docs/sdk
  • See the /docs/sdk/README.md for structural overview
  • Deprecate /docs/guide/sdk (everything has been moved to /docs/sdk)

@codecov
Copy link

codecov bot commented Jun 17, 2018

Codecov Report

Merging #1289 into develop will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           develop    #1289   +/-   ##
========================================
  Coverage    65.61%   65.61%           
========================================
  Files          103      103           
  Lines         5572     5572           
========================================
  Hits          3656     3656           
  Misses        1713     1713           
  Partials       203      203

@ebuchman ebuchman changed the title WIP: Refactor Docs Refactor Docs Jun 17, 2018
@ebuchman
Copy link
Member Author

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 ...

@ebuchman ebuchman force-pushed the bucky/docs branch 2 times, most recently from ac2903d to 105d064 Compare June 18, 2018 19:10
@ebuchman
Copy link
Member Author

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:

  • Goal is to build up to Basecoin through a series of apps. Each app builds on the last one until we get to Basecoin
  • App1: just messages, handlers, baseapp, store (no accounts, tx, amino, keeper, etc.)
  • App2: Introduce Amino
  • App3: Accounts and Transactions
  • App4: Keepers

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.

@jbibla
Copy link
Contributor

jbibla commented Jun 21, 2018

what's the status on this PR?

@ebuchman
Copy link
Member Author

Just rebased on develop. Let's merge when tests pass and pick up from there

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

Successfully merging this pull request may close these issues.

2 participants