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: Merge sway reference section into the sway book #6492

Open
wants to merge 11 commits into
base: master
Choose a base branch
from

Conversation

laishawadhwa
Copy link
Contributor

Description

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.

@laishawadhwa laishawadhwa requested review from a team as code owners September 3, 2024 12:52
IGI-111
IGI-111 previously approved these changes Sep 3, 2024
@IGI-111
Copy link
Contributor

IGI-111 commented Sep 3, 2024

We should think about deleting the reference once the merge is fully done.

@laishawadhwa
Copy link
Contributor Author

We should think about deleting the reference once the merge is fully done.

Agreed @IGI-111 : Will add more sections from the reference section within the book before deleting the section

@sdankel
Copy link
Member

sdankel commented Sep 6, 2024

@laishawadhwa You'll need to add Namespaces to docs/book/spell-check-custom-words.txt to fix the spellcheck CI, as well as fix these lint errors:

docs/book/src/reference/known_issues_and_workarounds.md:11 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
docs/book/src/reference/known_issues_and_workarounds.md:20:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
docs/book/src/reference/known_issues_and_workarounds.md:21:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
docs/book/src/reference/known_issues_and_workarounds.md:22:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
docs/book/src/reference/known_issues_and_workarounds.md:23:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
docs/book/src/reference/known_issues_and_workarounds.md:39 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]

Comment on lines +77 to +79
- [Initialization](./reference/storage/init.md)
- [Reading & Writing](./reference/storage/read-write.md)
- [Libraries](./reference/storage/libraries/index.md)
Copy link
Member

Choose a reason for hiding this comment

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

I think this error means you can't have these links nested here:

AssertionError [ERR_ASSERTION]: cannot nest subfolders in SUMMARY.md

Suggested change
- [Initialization](./reference/storage/init.md)
- [Reading & Writing](./reference/storage/read-write.md)
- [Libraries](./reference/storage/libraries/index.md)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Will update the failing checks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants