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 docs to 1.0 format #1028

Closed
ethanfrey opened this issue Jul 28, 2021 · 9 comments
Closed

Update docs to 1.0 format #1028

ethanfrey opened this issue Jul 28, 2021 · 9 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@ethanfrey
Copy link
Member

Both SEMANTICS.md and IBC.md are outdated (using 0.14 style).

@hashedone raised this point

@hashedone
Copy link
Contributor

Also make sure we have things documented in code - there are missing docs for example https://docs.rs/cosmwasm-std/0.16.0-rc5/cosmwasm_std/struct.Response.html has undocumented fields, or https://docs.rs/cosmwasm-std/0.16.0-rc5/cosmwasm_std/struct.HumanAddr.html has deprecation note, without info what to use instead.

@ethanfrey ethanfrey added the documentation Improvements or additions to documentation label Aug 9, 2021
@ethanfrey
Copy link
Member Author

I just went to use SEMANTICS.md as a reference and the mix of messages/submessages is a bit disconcerting

@ethanfrey ethanfrey added this to the 0.16.1 milestone Aug 9, 2021
@uint
Copy link
Contributor

uint commented Aug 9, 2021

I just went to use SEMANTICS.md as a reference and the mix of messages/submessages is a bit disconcerting

I keep wondering if it's too confusing as well.

@ethanfrey
Copy link
Member Author

It is supposed to be a complete documentation of the system. It is a useful spec for writing wasmd and multi-test and reasoning about this.

That said, we definitely need to update it. And if we can simplify it without removing information, I am happy for that

@webmaster128 webmaster128 modified the milestones: 0.16.1, 1.0.0 Aug 30, 2021
@ethanfrey
Copy link
Member Author

Not sure if it makes sense for codefest.

Someone must understand both the 0.14 and the 1.0 APIs.
It is about changing code blocks not just text.

@ethanfrey ethanfrey changed the title Update docs to 0.16 format Update docs to 1.0 format Oct 18, 2021
@ethanfrey
Copy link
Member Author

Honestly, I don't think there is much in cosmwasm that is ready for beginners to contribute. Thus, we have no made the codefest label

@barriebyron
Copy link

thanks @ethanfrey for the comment and attention!

@chipshort
Copy link
Collaborator

Closing this, as #1963 covers updating SEMANTICS.md and we ultimately want to move this information into the new documentation page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

6 participants