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

Reference Sway-Libs, Sway-Standards, and Sway-Applications In Sway Book #5944

Merged
merged 11 commits into from
May 8, 2024

Conversation

bitzoic
Copy link
Member

@bitzoic bitzoic commented May 2, 2024

Description

Previously the Sway book did not have any sections on Sway-Libs, Sway-Standards, or Sway-Applications and was sparsely mentioned. Sections for each repository have been added with a brief overview of what they contain. Links to any app, standard, or library have also been provided.

Any use of the sway-libs repository has been replaced with the Sway-Libs book. This should eventually be replaced with a doc hub link when it has been integrated and the same for Sway-Apps and Sway-Libs.

Closes #5780

Checklist

  • I have linked to any relevant issues.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have updated the documentation where relevant (API docs, the reference, and the Sway book).
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added (or requested a maintainer to add) the necessary Breaking* or New Feature labels where relevant.
  • I have done my best to ensure that my PR adheres to the Fuel Labs Code Review Standards.
  • I have requested a review from the relevant team or maintainers.

@bitzoic bitzoic added enhancement New feature or request The Sway Book Everything to do with the Sway Book labels May 2, 2024
@bitzoic bitzoic requested a review from a team May 2, 2024 06:48
@bitzoic bitzoic self-assigned this May 2, 2024
@bitzoic bitzoic linked an issue May 2, 2024 that may be closed by this pull request
@bitzoic bitzoic changed the title Integrate sway-libs book and sway-standards further into sway docs Reference Sway-Libs, Sway-Standards, and Sway-Applications In Sway Book May 2, 2024
Copy link
Contributor

@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.

nice! Just have a small nit, otherwise LGTM

docs/book/spell-check-custom-words.txt Outdated Show resolved Hide resolved
@bitzoic bitzoic requested review from sarahschwartz and a team May 3, 2024 04:13
K1-R1
K1-R1 previously approved these changes May 3, 2024
sarahschwartz
sarahschwartz previously approved these changes May 3, 2024
@bitzoic bitzoic dismissed stale reviews from sarahschwartz and K1-R1 via e71c1cc May 6, 2024 02:52
@bitzoic bitzoic requested review from sarahschwartz, K1-R1 and a team May 6, 2024 02:52
@K1-R1 K1-R1 requested a review from a team May 6, 2024 10:32
@bitzoic bitzoic enabled auto-merge (squash) May 6, 2024 11:08
@bitzoic bitzoic requested a review from a team May 7, 2024 04:20
@bitzoic bitzoic merged commit da05b9d into master May 8, 2024
37 checks passed
@bitzoic bitzoic deleted the bitzoic-5780 branch May 8, 2024 13:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request The Sway Book Everything to do with the Sway Book
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve visibility of Sway-Standards and Sway-Libs in the Sway Book
3 participants