Skip to content

docs(book): replace manual placeholders with environment variables - #52

Draft
Nalon wants to merge 1 commit into
mainfrom
feat/book-commands
Draft

Nalon wants to merge 1 commit into
mainfrom
feat/book-commands

Conversation

@Nalon

@Nalon Nalon commented Oct 23, 2026

Copy link
Copy Markdown
Collaborator

Summary

Book commands previously used <PLACEHOLDERS> that developers had to replace by hand in every command, which slowed the walkthroughs down and invited copy/paste mistakes. This PR moves them to shell variables that are set once and reused.

What changed

  • .env.example: new blank keys for MY_EOA and the Sepolia, Amoy and Fuji constants (router, chain selector, LINK, CCIP-BnM, ARM proxy, registry module owner, token admin registry). No values are committed; developers copy them from the CCIP Directory.
  • book/src/index.md: new "Environment Variables" section with a "How the commands handle values" note: $VAR is expanded by the shell, where each value comes from, what happens when one is unset, and that exports last only for the current terminal. Load with set -a; source .env; set +a.
  • Examples 01-10 and Legacy 01-02: each chapter gets a "Chapter Parameters" block with working defaults. Deploy steps now end with export X=0x... lines so later steps pick the addresses up automatically.
  • SDK send/track, CLI and API pages: converted to the same variables.

This branch has not been deployed

No deployments
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.

1 participant