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

Use docs hub in favor of book #255

Merged
merged 8 commits into from
Jun 11, 2024
Merged

Use docs hub in favor of book #255

merged 8 commits into from
Jun 11, 2024

Conversation

bitzoic
Copy link
Member

@bitzoic bitzoic commented Jun 5, 2024

Type of change

  • Improvement (refactoring, restructuring repository, cleaning tech debt, ...)
  • Documentation

Changes

The following changes have been made:

  • Removes the Sway-Libs book deployment from CI
  • All instances mentioning the Sway-Libs book now refer to the docs hub
  • Removes the Libraries Overview libraries.md page in the book in favor of a more extensive index.md home page.
  • Updates all links for Sway-Standards to use the docs hub over the repository

Notes

  • Now that the sway-lib docs hub exists, we no longer need to book.

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 the Documentation Improvements or additions to documentation label Jun 5, 2024
@bitzoic bitzoic requested a review from a team June 5, 2024 07:56
@bitzoic bitzoic self-assigned this Jun 5, 2024
@bitzoic bitzoic requested a review from a team as a code owner June 5, 2024 07:56
K1-R1
K1-R1 previously approved these changes Jun 5, 2024
@K1-R1 K1-R1 requested review from a team June 5, 2024 15:31
@bitzoic bitzoic merged commit bdd8de8 into master Jun 11, 2024
10 checks passed
@bitzoic bitzoic deleted the bitzoic-point-to-docs-hub branch June 11, 2024 04:42
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants