-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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: use an MD book #185
docs: use an MD book #185
Conversation
- I used the workflow from the Sway repository so it *should* work
Created issue #186 to track the "full completion" of a proper documentation with examples. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You might need to manually add a FuelLabs/sway@4882a99 after the gh-pages branch is created for the first time.
Co-authored-by: John Adler <adlerjohn@users.noreply.github.com>
Co-authored-by: John Adler <adlerjohn@users.noreply.github.com>
Co-authored-by: John Adler <adlerjohn@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, but will defer to @digorithm
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work on this!
This PR closes #146 by moving documentation into an MDbook.
WARNING: this is a work-in-progress, as documentation needs to be rewritten more fully.
This is also dependent on #101, and will be enriched with the examples from this issue.
The idea was just to create the original structure for the MDbook before the Dubai workshop.