-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
docs: make them a better guide using example apps #1330
Comments
Here is how I see things @ebuchman. I think we need two things:
Because we don't have the former, I had to put more info in the app tutorial for it to be self-sufficient. Ideally, we would have the canonical doc and I could offload lots of information to it. So to summarize I agree with the approach you mentioned in the app tuto PR: "Then this tutorial, and others like it, have a common foundation of docs to build on, and can focus on the meat of the example". I think this "common foundation" should be a formal, canonical documentation of the SDK that we don't have at the moment. This is the reason why I had to expand on the app tutorial. Finally, I'm not sure the material in the tuto would fit the core SDK doc (except maybe the intro and jae's coderun). I have explained things not formally but in a way that is easy to understand. This is far from formal/canonical. I would be happy to trim the tuto later once we do have a more formal core sdk doc. |
this is well under way!
should it go in the academy then? perhaps a blog post too? |
I answered in the app PR. I think it should go in our docs. It's good to have at least one user-friendly tutorial there to complement the formal docs. And a blog post will accompany the release of the tuto. |
Did some docs refactor in #1289
Introduced a new table of contents: https://github.com/cosmos/cosmos-sdk/tree/develop/docs/
The
Core
section should use real example apps to actually demonstrate how everything works, with the goal being to build towards full blown basecoin (or gaia).As suggested in #1289 (comment) this can be done in 5 iterations:
From, To, Amount
The text was updated successfully, but these errors were encountered: