Skip to content

docs: clarify contract ID placeholders and env vars in deployments.md#673

Open
ZainabJanee wants to merge 1 commit into
AnnabelJoe:mainfrom
ZainabJanee:fix/522-deployment-docs
Open

docs: clarify contract ID placeholders and env vars in deployments.md#673
ZainabJanee wants to merge 1 commit into
AnnabelJoe:mainfrom
ZainabJanee:fix/522-deployment-docs

Conversation

@ZainabJanee

Copy link
Copy Markdown
Contributor

Summary

Closes #522

Rewrites docs/deployments.md so maintainers clearly know which values are placeholders and how to fill them in.

Changes

  • Replace ambiguous _(set after first deploy)_ with explicit <PLACEHOLDER> tokens (e.g. <TESTNET_ENERGY_TOKEN_ID>) that cannot be mistaken for real contract IDs.
  • Add a placeholder convention note at the top of the file.
  • Add required environment variable blocks for both testnet and mainnet, matching the variable names in .env.example.
  • Add a numbered "How to update this file" section linking to docs/DEPLOYMENT.md.

Tested

Documentation-only change; no code modified.

Closes AnnabelJoe#522

- Replace ambiguous '_(set after first deploy)_' text with explicit
  <PLACEHOLDER> tokens so maintainers know what to fill in.
- Add required env var blocks for both testnet and mainnet.
- Add placeholder convention note at the top of the file.
- Link update steps to DEPLOYMENT.md for the full deploy guide.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update deployment docs with actual or placeholder contract IDs

1 participant