sway icon indicating copy to clipboard operation
sway copied to clipboard

docs: Merge sway reference section into the sway book

Open laishawadhwa opened this issue 1 year ago • 3 comments

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 avatar Sep 03 '24 12:09 laishawadhwa

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

IGI-111 avatar Sep 03 '24 13:09 IGI-111

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

laishawadhwa avatar Sep 05 '24 08:09 laishawadhwa

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

sdankel avatar Sep 06 '24 17:09 sdankel

Thanks for the contribution! Unfortunately we can't verify the commit author(s): Laisha Wadhwa <l***@L***.local>. One possible solution is to add that email to your GitHub account. Alternatively you can change your commits to another email and force push the change. After getting your commits associated with your GitHub account, sign the Fuel Labs Contributor License Agreement and this Pull Request will be revalidated.

fuel-cla-bot[bot] avatar Jan 11 '25 07:01 fuel-cla-bot[bot]