Skip to content

docs(templates): add comments and guidance to .template.env files#2651

Open
0xAxiom wants to merge 1 commit into
coinbase:mainfrom
0xAxiom:docs/improve-template-env-comments
Open

docs(templates): add comments and guidance to .template.env files#2651
0xAxiom wants to merge 1 commit into
coinbase:mainfrom
0xAxiom:docs/improve-template-env-comments

Conversation

@0xAxiom
Copy link
Copy Markdown

@0xAxiom 0xAxiom commented May 18, 2026

Summary

Both .template.env files (onchainkit-nextjs and minikit-nextjs) were minimal stubs with no guidance, which caused setup friction for developers new to Base.

This PR adds:

  • Descriptive comments for every variable
  • A link to the CDP portal to obtain the OnchainKit API key
  • A commented-out NEXT_PUBLIC_RPC_URL section explaining Base Sepolia testnet vs mainnet
  • A commented-out NEXT_PUBLIC_WC_PROJECT_ID entry with a link to WalletConnect Cloud
  • An explanation of NEXT_PUBLIC_URL in the MiniKit template (when it's needed and an example value for local dev)

Closes #2644

Test plan

  • Copy .template.env.env.local, fill in only the API key, and verify npm run dev works with no additional changes
  • Confirm no existing variable names were changed (no runtime breakage)

Both template environment files were empty stubs with no guidance.
Add descriptive comments for each variable, note where to obtain the
API key and WalletConnect project ID, and include a commented-out
RPC URL section explaining Base Sepolia testnet vs mainnet options.

Closes coinbase#2644
@vercel
Copy link
Copy Markdown

vercel Bot commented May 18, 2026

@0xAxiom is attempting to deploy a commit to the Coinbase Team on Vercel.

A member of the Team first needs to authorize it.

@cb-heimdall
Copy link
Copy Markdown

🟡 Heimdall Review Status

Requirement Status More Info
Reviews 🟡 0/1
Denominator calculation
Show calculation
1 if user is bot 0
1 if user is external 0
2 if repo is sensitive 0
From .codeflow.yml 1
Additional review requirements
Show calculation
Max 0
0
From CODEOWNERS 0
Global minimum 0
Max 1
1
1 if commit is unverified 0
Sum 1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

Documentation Request: Improve template environment configuration for Base Sepolia development

2 participants