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.

Sign up for GitHub

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

Jump to bottom

Additional documentation for the Sway book. #478

Merged
merged 10 commits into from
Dec 28, 2021
Merged

Additional documentation for the Sway book. #478

merged 10 commits into from
Dec 28, 2021

Conversation

sezna
Copy link
Contributor

@sezna sezna commented Dec 22, 2021

As the title says, writing more documentation for the Sway book. I've been using The Rust Book as a template for structure and tone.

@sezna sezna self-assigned this Dec 22, 2021
@nfurfaro
Copy link
Contributor

looking good. If I get a chance I'll add more on the Address type which is now implemented, as well as the Contract ID type

adlerjohn
adlerjohn reviewed Dec 23, 2021
View reviewed changes
docs/src/advanced/generic_types.md Outdated Show resolved Hide resolved
docs/src/advanced/generic_types.md Outdated Show resolved Hide resolved
docs/src/basics/built_in_types.md Outdated Show resolved Hide resolved
docs/src/basics/built_in_types.md Outdated Show resolved Hide resolved
@SilentCicero
Copy link
Member

SilentCicero commented Dec 23, 2021 •
edited by adlerjohn
Loading

@sezna commentary, I'd like to see the following:

  • Installation: Far more work on the installation and setup process of the language, language server and Forc. This should be filled in once we publish those to cargo. I.e. the cargo install lines etc. I don't want to have to go to each individual Github to find out how to install each thing. Just tell me how to install it.
  • Why Sway: A section about what makes Sway different (in the beginning), why would i want to use this over Solidity, and why we chose to build our own language instead of using Rust.
  • Storage: A sub section on storage, storage layout and why we chose this syntax (i.e. to clearly define when your touching storage).
  • Example Explanations: More explanation of what each example does, and generally more examples.
  • Printing: How do I print a value to see a value, can you do a small sub section on just "communicating with Sway" i.e. what is our equivalent or println or print. If it's just the main function return that's fine for now. But make that clear and also state our intention that we will add these things in the future.
  • Roadmap: Also add to the roadmap more specific details about logging events and encoders and decoders.
  • Videos: Also if they are still available and make sense, adding in a section with your videos you did a while back would also be valuable. But I'm not sure if they are up to date.

In general, this is okay, but I'm still pretty underwhelmed, the Zinc docs are a good example to strive for.

@nfurfaro
Updating sway types & rename colored coins. (#481)
aeb2b59 
* Update Address and ContractID types

* Rename colored coins

* Cleanup markdown

* Move Address and ContractId types to new book section

* Update SUMMARY.md

* Remove colored-coins

* Fixup
nfurfaro
nfurfaro previously approved these changes Dec 23, 2021
View reviewed changes
Copy link
Contributor

@nfurfaro nfurfaro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good overall.

@sezna @adlerjohn
Update docs/src/advanced/generic_types.md
e199955 
Co-authored-by: John Adler <adlerjohn@users.noreply.github.com>
sezna and others added 6 commits December 23, 2021 12:49
@sezna @adlerjohn
Update docs/src/advanced/generic_types.md
3918e8d 
Co-authored-by: John Adler <adlerjohn@users.noreply.github.com>
@sezna
pull from master
7be636d
@adlerjohn
More doc updates (#501)
56c4e8e 
* fmt

* New language server.

* Add basics page index.

* Index updates.

* Update index.

* Update readme.

* Update install docs.

* Clean up Forc project intro.

* Skeleton for why sway.
@adlerjohn
Fix location of Cargo.toml. (#502)
ac71d1a
@sezna
WIP storage docs
ee583a1
@sezna
docs on reference types and purity: wip
7f3db10
@adlerjohn adlerjohn added the enhancement New feature or request label Dec 28, 2021
@sezna sezna marked this pull request as ready for review December 28, 2021 01:24
@sezna sezna merged commit b42d016 into master Dec 28, 2021
@sezna sezna deleted the sezna/dec_docs_update branch December 28, 2021 01:24
@adlerjohn adlerjohn added The Sway Book Everything to do with the Sway Book and removed documentation labels Jan 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@adlerjohn adlerjohn adlerjohn approved these changes

@nfurfaro nfurfaro nfurfaro left review comments

@SilentCicero SilentCicero Awaiting requested review from SilentCicero

Assignees

@sezna sezna

Labels
enhancement New feature or request The Sway Book Everything to do with the Sway Book
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@sezna @nfurfaro @SilentCicero @adlerjohn