fuels-ts icon indicating copy to clipboard operation
fuels-ts copied to clipboard
verified publisher icon FuelLabs

docs: reorganize documentation

Open petertonysmith94 opened this issue 1 year ago • 4 comments

Closes #1899

Re-organize the menu and page structure for the Docs

Summary

  • Seperated our docs into the following sections Introduction, Basics, Essentials, Extras, Tooling.
Before After
Screenshot 2024-03-21 at 13 47 45 Screenshot 2024-03-21 at 13 47 45

petertonysmith94 avatar Mar 20 '24 19:03 petertonysmith94

Pipeline currently failing on an assertion for the expected structure.

We could update the action FuelLabs/github-actions.

Re-nested under the guide https://github.com/FuelLabs/fuels-ts/pull/1906/commits/b1ee6acf02120eaf43e2b46adfb9deb91e57d26a

petertonysmith94 avatar Mar 20 '24 21:03 petertonysmith94

Nice work, I think my preference is option B as I'm concerned about compatibility with the docs hub.

danielbate avatar Mar 21 '24 17:03 danielbate

✨ A PR has been created under the rc-1906 tag on fuels-wallet repo. https://github.com/FuelLabs/fuels-wallet/pull/1172

github-actions[bot] avatar Mar 22 '24 08:03 github-actions[bot]

@arboleya and @danielbate - thanks for reviewing 🙏🏼

Made the following changed, based on your comments:

  • Removed table of contents https://github.com/FuelLabs/fuels-ts/pull/1906/commits/a9eba896166a597199ef1b78d611f84dd6eeafcf
  • Removed glossary https://github.com/FuelLabs/fuels-ts/pull/1906/commits/653f7f04826cfbb03d39b0fe60fd18b5b26df9bf
  • All main sections expanded https://github.com/FuelLabs/fuels-ts/pull/1906/commits/b1588540ccf8117eccd5d0b88b24750494cdeb82

petertonysmith94 avatar Mar 23 '24 08:03 petertonysmith94

Coverage Report:

Lines Branches Functions Statements
81.35%(+0%) 71.84%(+0%) 78.98%(+0%) 81.46%(+0%)
Changed Files:

Coverage values did not change👌.

github-actions[bot] avatar Mar 25 '24 11:03 github-actions[bot]