Migrate all code-snippets from `fuel-gauge` to `docs-snippets`

FuelLabs / fuels-ts

Fuel Network Typescript SDK

https://docs.fuel.network/docs/fuels-ts/

Apache License 2.0

44.37k stars 1.33k forks source link

Migrate all code-snippets from `fuel-gauge` to `docs-snippets` #1505

Open danielbate opened 6 months ago

danielbate commented 6 months ago

We currently have quite a few tests that references documentation from fuel-gauge. These scenarios are at times improperly formed in order to be more verbose and illustrate techniques rather than validate the end to end functionality of the SDK. As that is the intended usage of fuel-gauge, we should instead move fuel-gauge/src/doc-examples.test.ts to appropriate places in apps/docs-snippets. The documentation references will also need to be altered as the links will have been broken.

petertonysmith94 commented 5 months ago

@danielbate pls

danielbate commented 5 months ago

Sorry meant to assign you @petertonysmith94

petertonysmith94 commented 5 months ago

Notes:

vector-4 Doesn't show a return value in the documentation // expect value would be beneficial.

petertonysmith94 commented 2 months ago

Unassigned the issue, moved the wallet code snippets and left the PR in draft. Might be helpful as part of https://github.com/FuelLabs/fuels-ts/issues/1919.

May be worth consideration while the docs revamp is in progress https://github.com/FuelLabs/fuels-ts/issues/1924