Skip to content

docs: improve documentation for deployed programs#3962

Open
airope wants to merge 1 commit intoFuelLabs:masterfrom
airope:docs/deployed-programs
Open

docs: improve documentation for deployed programs#3962
airope wants to merge 1 commit intoFuelLabs:masterfrom
airope:docs/deployed-programs

Conversation

@airope
Copy link

@airope airope commented Mar 3, 2026

Summary

Closes #3800

Improves the deployment documentation for contracts, predicates, and scripts with the following enhancements:

  • Added Sway source examples to each deployment guide so users can see the program being deployed
  • Documented both deployment mechanisms (CLI via fuels deploy and dynamic/programmatic deployment) across all three program types
  • Restructured deploying-contracts.md to clearly separate CLI vs dynamic deployment paths
  • Improved managing-deployed-contracts.md to lead with the most common use case (connecting to an already-deployed contract)
  • Added cross-references between deployment and managing docs for better discoverability

Checklist

@cursor
Copy link

cursor bot commented Mar 3, 2026

PR Summary

Low Risk
Documentation-only updates; primary risk is minor user confusion if CLI/programmatic steps or code snippet anchors are incorrect.

Overview
Clarifies program deployment docs by explicitly separating CLI (fuels deploy) vs dynamic/programmatic deployment flows for contracts, predicates, and scripts, and adds embedded Sway source examples to each guide.

Reworks managing-deployed-contracts.md to lead with connecting to an existing contract (contract ID + ABI), adds guidance for B256 contract IDs, and adds a Next steps cross-link from contract deployment to contract management.

Also updates .gitignore to ignore .claude/ and adds region markers to the example Sway contract used in docs.

Written by Cursor Bugbot for commit ff5028c. This will update automatically on new commits. Configure here.

@github-actions github-actions bot added the docs Requests pertinent to documentation label Mar 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla:signed docs Requests pertinent to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve documentation for deployed programs

1 participant