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

Introduce the Sway-Libs Book #225

Merged
merged 19 commits into from
Apr 5, 2024
Merged

Introduce the Sway-Libs Book #225

merged 19 commits into from
Apr 5, 2024

Conversation

bitzoic
Copy link
Member

@bitzoic bitzoic commented Mar 28, 2024 •
edited
Loading

Type of change

  • New feature

Changes

The following changes have been made:

  • Creates the Sway-Libs Book
  • Removes all READMEs and SPECIFICATION files
  • Moves contributing book deployment to a different file

Notes

  • Creates a basic outline with example code but complete examples are still missing.
  • Dependent on Remove Workspaces #224 to be merged first

Related Issues

Closes #223

@bitzoic bitzoic added Documentation Improvements or additions to documentation New Feature New addition that does not currently exist labels Mar 28, 2024
@bitzoic bitzoic self-assigned this Mar 28, 2024
@bitzoic bitzoic linked an issue Mar 28, 2024 that may be closed by this pull request
Create the Sway-libs book #223
Closed
@bitzoic bitzoic marked this pull request as ready for review March 29, 2024 03:10
@bitzoic bitzoic requested a review from a team as a code owner March 29, 2024 03:10
@bitzoic bitzoic requested a review from a team April 1, 2024 02:11
sarahschwartz
sarahschwartz reviewed Apr 1, 2024
View reviewed changes
Copy link

@sarahschwartz sarahschwartz left a comment

Choose a reason for hiding this comment

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

It would be great if you could also add the same docs tests used for the other docs repos: https://github.com/FuelLabs/github-actions/blob/master/docs-hub/README.md

It will require you to remove the nested folders, so this is in a format that is compatible with the docs-hub.

@bitzoic bitzoic requested review from sarahschwartz and a team April 2, 2024 04:55
@bitzoic
Copy link
Member Author

bitzoic commented Apr 2, 2024 •
edited
Loading

CI to check links will fail as the README is self referencing this book which hasn't deployed yet.

K1-R1
K1-R1 previously approved these changes Apr 2, 2024
View reviewed changes
Copy link
Contributor

@K1-R1 K1-R1 left a comment

Choose a reason for hiding this comment

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

LGTM

docs/book/book.toml Outdated Show resolved Hide resolved
@bitzoic bitzoic requested review from K1-R1 and a team April 3, 2024 05:37
@sarahschwartz
Copy link

Thanks for flatting the nav - it's looking really good! Some of the links are still failing (not the README ones). It looks like mdbook has a mechanism to fix some of them automatically, but technically the getting started page links should be ../getting_started/index.md instead of ../../../getting_started/index.md for example in the merkle/index page. This will be needed for the docs-hub. There are a few other broken links too if you review the test results: https://github.com/FuelLabs/sway-libs/actions/runs/8533783051/job/23377019484?pr=225

@bitzoic
Copy link
Member Author

bitzoic commented Apr 4, 2024

Thanks for flatting the nav - it's looking really good! Some of the links are still failing (not the README ones). It looks like mdbook has a mechanism to fix some of them automatically, but technically the getting started page links should be ../getting_started/index.md instead of ../../../getting_started/index.md for example in the merkle/index page. This will be needed for the docs-hub. There are a few other broken links too if you review the test results: https://github.com/FuelLabs/sway-libs/actions/runs/8533783051/job/23377019484?pr=225

Only README links are dead now

@bitzoic bitzoic mentioned this pull request Apr 4, 2024
Merged
@bitzoic bitzoic requested review from sarahschwartz and a team April 5, 2024 02:07
@bitzoic bitzoic mentioned this pull request Apr 5, 2024
Merged
@bitzoic bitzoic merged commit 178cc09 into master Apr 5, 2024
8 of 9 checks passed
@bitzoic bitzoic deleted the bitzoic-create-the-sway-libs-book branch April 5, 2024 21:37
bitzoic added a commit that referenced this pull request Apr 8, 2024
@bitzoic
Change sway_libs::asset::mint::* to sway_libs::asset::supply::* (#…
6dfbca5 
…227)

## Type of change

<!--Delete points that do not apply-->

- Improvement (refactoring, restructuring repository, cleaning tech
debt, ...)

## Notes

- After internal discussion it was decided that the term supply is more
appropriate than mint for the minting and burning portion of the asset
library.
- This should be merged after
#225

## Changes

The following changes have been made:

- The `mint.sw` file has been changed to `supply.sw`, changing the
import path from `sway_libs::asset::mint::*` to
`sway_libs::asset::supply::*`

## Related Issues

<!--Delete everything after the "#" symbol and replace it with a number.
No spaces between hash and number-->

Closes #222
bitzoic added a commit that referenced this pull request Apr 16, 2024
@bitzoic
Bump to forc v0.53.0 (#226)
57dbed5 
## Type of change

<!--Delete points that do not apply-->

- Improvement (refactoring, restructuring repository, cleaning tech
debt, ...)

## Changes

The following changes have been made:

- Updates Sway-Libs to forc v0.53.0

## Notes

- Dependent on #225
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sarahschwartz sarahschwartz sarahschwartz approved these changes

@K1-R1 K1-R1 K1-R1 approved these changes

Assignees

@bitzoic bitzoic

Labels
Documentation Improvements or additions to documentation New Feature New addition that does not currently exist
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Create the Sway-libs book
3 participants
@bitzoic @sarahschwartz @K1-R1