Icon HelpCircleForumIcon Link

⌘K

Icon HelpCircleForumIcon Link
Icon AlertTriangle

Mainnet docs are version-pinned. Check each section's exact version in the sidebar; it can lag the newest upstream release.

Icon LinkVersions

There are two version sets of documentation in docs-hub: the default mainnet-targeted set and nightly.

  • The default set targets the named mainnet Fuelup channel. Fuelup's undated latest channel is a network alias — at the time of writing it resolves to mainnet (verify against the Fuelup channel reference Icon Link); it does not mean the newest upstream release.
  • Testnet is a separate named Fuelup channel. It may temporarily contain the same components as mainnet, but documentation must not assume that the two manifests are always identical.
  • The nightly set follows newer upstream documentation sources. Its components may be unstable or incompatible with each other and with a deployed network.

Every rendered section displays its exact source version in the sidebar. The mainnet target, testnet target, newest upstream release, and rendered source version are distinct facts. Do not describe all four as "latest" or "stable."

Icon LinkUpdating the Nightly Versions

There is a GitHub action that runs Monday through Friday at 12:00 UTC to update the nightly versions of the docs.

You can also update the nightly versions locally by running the command below:

pnpm docs:update:nightly

The nightly versions should be kept at the latest release on GitHub for each tool. This is a documentation freshness policy, not a network compatibility claim.

Icon LinkUpdating the Default Versions

To change the default versions, update the src/config/versions.json Icon Link file and run this command:

pnpm docs:update

This command will both update the the default versions to match the configuration file and make sure the nightly versions are updated.

Here is how to decide what default versions to use:

  • The Sway and core forc versions should match the named mainnet channel manifest. Check the testnet manifest separately and document any difference.
  • Network-facing Forc plugins can be released from repositories other than Sway and can have independent versions. Do not infer plugin compatibility from the core Forc version alone.
  • The wallet SDK should match the Fuel Wallet extension when it is compatible with the mainnet channel. If it is not, use the newest verified compatible release and record that constraint.
  • The Rust and TypeScript SDK versions should be the newest releases verified against the mainnet compiler, node, chain ID, and generated ABI.
  • The GraphQL API and Specs books should reflect the fuel-core version used by mainnet. If testnet differs, surface the testnet version separately.

Updating src/config/versions.json records the desired target; it does not by itself update the rendered docs. The stable Sway source submodule and generated Forc command-book submodule must both exist for the exact selected version. Never merge a source-only bump: forc-gen-docs deliberately fails when the matching generated artifact is absent so that older command help cannot be published under a newer label.

After updating, run the full documentation build and verify that:

  1. the versions displayed in the sidebar match the checked-out submodules;
  2. the Sway and Forc source links resolve to the displayed tags;
  3. every generated Forc command page came from that same exact version; and
  4. the installation guide agrees with Fuelup's current channel reference.