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

docs: use an MD book #185

Merged
merged 6 commits into from
Mar 28, 2022
Merged

docs: use an MD book #185

merged 6 commits into from
Mar 28, 2022

Conversation

iqdecay
Copy link
Contributor

@iqdecay iqdecay commented Mar 28, 2022

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.

- I used the workflow from the Sway repository so it *should* work
@iqdecay
Copy link
Contributor Author

iqdecay commented Mar 28, 2022

Created issue #186 to track the "full completion" of a proper documentation with examples.

@iqdecay iqdecay self-assigned this Mar 28, 2022
@iqdecay iqdecay added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 28, 2022
Copy link
Contributor

@adlerjohn adlerjohn left a 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.

.gitignore Outdated Show resolved Hide resolved
docs/book.toml Outdated Show resolved Hide resolved
docs/src/getting-started/setup.md Outdated Show resolved Hide resolved
docs/src/getting-started/setup.md Outdated Show resolved Hide resolved
docs/src/getting-started/type-safe-bindings.md Outdated Show resolved Hide resolved
docs/src/getting-started/type-safe-bindings.md Outdated Show resolved Hide resolved
iqdecay and others added 3 commits March 28, 2022 03:42
Co-authored-by: John Adler <adlerjohn@users.noreply.github.com>
Co-authored-by: John Adler <adlerjohn@users.noreply.github.com>
@iqdecay iqdecay requested a review from adlerjohn March 28, 2022 02:15
Co-authored-by: John Adler <adlerjohn@users.noreply.github.com>
Copy link
Contributor

@adlerjohn adlerjohn left a 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

Copy link
Member

@digorithm digorithm left a 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!

@iqdecay iqdecay merged commit e5f1181 into master Mar 28, 2022
@iqdecay iqdecay deleted the vnepveu/docs-use-md-book branch March 28, 2022 16:31
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 enhancement New feature or request
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Move fuels-rs documentation to an mdbook
3 participants