Add Appendix A: Keywords to Sway book

[andrewvious]

Description

closes #4932

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.

[Braqzen]

1. I have not checked all the links to ensure that they point to where they ought to
2. Unfortunately, I really do not have the bandwidth to make individual suggestions for each definition but I would re-write most / almost all of the definitions to be more accurate / concise. Most aren't bad but ought to be updated imo

[andrewvious]

1. I have not checked all the links to ensure that they point to where they ought to
2. Unfortunately, I really do not have the bandwidth to make individual suggestions for each definition but I would re-write most / almost all of the definitions to be more accurate / concise. Most aren't bad but ought to be updated imo

Appreciate the review, all the links I found should check out! As far as the definitions I tried to make it as boiled down as possible, using rust's appendix as reference (https://doc.rust-lang.org/book/appendix-01-keywords.html). However, I can change any you feel need to be updated.

[eureka-cpu]

Hey @andrewvious really great work, checked all the links and they're correct.

I've requested just one change and I think this should be good to go.

[eureka-cpu]

LGTM nice job

[sarahschwartz]

Thank you for your contribution! Can you update the links to the sway book so that they are all relative instead of absolute urls? This way the versions won't need to be updated.

[andrewvious]

Thank you for your contribution! Can you update the links to the sway book so that they are all relative instead of absolute urls? This way the versions won't need to be updated.

I went ahead and set all the urls to the relative path in the book, but lost some precision the links had. Let me know if this works, or if there is a better way of doing it!

[Braqzen]

Thank you for your contribution! Can you update the links to the sway book so that they are all relative instead of absolute urls? This way the versions won't need to be updated.

I went ahead and set all the urls to the relative path in the book, but lost some precision the links had. Let me know if this works, or if there is a better way of doing it!

The reference seems to always point to a page instead of a specific heading. I don't recall if I did that because I couldn't link it precisely or because each section was meant to be a small page. If the page is too full then changing that page will inevitably lead to headings being changed and links being broken so it's better to structure content per page in a digestible manner.

I haven't tested the links but I wonder if we should be mixing the book and reference. The reference was meant to entirely replace the book, and hopefully it will before mainnet.

[Braqzen]

Quickly glancing through CI the linter fails because the links start with /docs instead of ./docs (I assume, haven't checked)

[sarahschwartz]

Thanks! I have one more nit: can you move this page into the existing Sway Reference section and remove the Appendix section?

[andrewvious]

Thanks! I have one more nit: can you move this page into the existing Sway Reference section and remove the Appendix section?

Would you mind further elaborating where inside the reference section you would prefer this to be moved to?
Should I create an Appendix in the Reference section?

[Braqzen]

Thanks! I have one more nit: can you move this page into the existing Sway Reference section and remove the Appendix section?

Would you mind further elaborating where inside the reference section you would prefer this to be moved to? Should I create an Appendix in the Reference section?

Move entire section from the book into the reference at the bottom

[sarahschwartz]

Number 11 in the navigation of the Sway Book is "Sway Reference". You can move the keywords page into that section, add to the existing index.md with a link, and delete the apendix folder.

[eureka-cpu]

LGTM, nice work