Advanced Storage Docs

[bitzoic]

Description

There have been a number of questions on the forum regarding storage and the section needed and update. The following changes have been made:

• Simplified basic storage examples
• Added examples that include structs
• Added basic examples that include StorageMap
• Added basic examples that include StorageVec
• Added basic examples that include StorageString
• Added basic examples that include StorageBytes
• Added advanced nested examples using StorageVec and StorageMap
• Added advanced nested examples using StorageString and StorageMap
• Added advanced nested examples using StorageBytes and StorageVec
• Added table of contents Removed due to CI errors not accepting TOB format
• Fixed inline docs on StorageString
• Fixed inline docs on StorageBytes
• Fixed inline docs on StorageKey

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.

[IGI-111]

I just want to say for the record that we will make big changes to storage to make it more intuitive in the near future, so much of this will likely have to be updated.

Still valuable to document the current behavior, of course.

[sarahschwartz]

This is great, thank you! What do you think about making pages in the common collections chapter for storagebytes, storagestring, and a nested collections page so the contract storage page isn't quite so long?

Having a table of contents at the top of the contract storage page would also be nice.

[K1-R1]

Looks good, happy to approve once above comments are addressed

[bitzoic]

I just want to say for the record that we will make big changes to storage to make it more intuitive in the near future, so much of this will likely have to be updated.

Still valuable to document the current behavior, of course.

Yes I am aware. The changes here also update the outline and format of the documentation which should be carried over to any updates to storage made

[bitzoic]

This is great, thank you! What do you think about making pages in the common collections chapter for storagebytes, storagestring, and a nested collections page so the contract storage page isn't quite so long?

Having a table of contents at the top of the contract storage page would also be nice.

StorageBytes and StorageString are very basic, the only additional function one can call besides the examples already provided is clear(). Not sure if this warrants a full page.

Common Collections is missing a lot of data types, such as String, Bytes. We may want to split this into storage and heap types. For now I've created an "Advanced Storage" page under the "Advanced" section.

Unfortunately, a table of contents isn't compatible with CI. I had one added and there are a number of resulting errors. Updates to CI would need to be made in another PR.