Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Improve quickstart guide formatting and environment setup clarity #1508

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs: Improve quickstart guide formatting and environment setup clarity #1508

wants to merge 2 commits into from

Conversation

DeVikingMark
Copy link

This PR enhances the Base quickstart guide with several improvements:

  • Remove quotes from environment variables in .env example for better consistency with common practices
  • Add warning message about requiring test ETH before contract deployment to prevent failed transactions
  • Clean up excessive line breaks at the end of the document
  • Improve readability by adding proper spacing after the foundryup command

These changes make the documentation more user-friendly and align with standard documentation practices.

Changes made:

  1. Simplified .env variables format
  2. Added explicit warning about test ETH requirements
  3. Reduced redundant
    tags
  4. Fixed spacing inconsistencies

Testing:

  • Verified all markdown formatting renders correctly
  • Confirmed all links are working
  • Checked that code examples are properly formatted

@vercel Vercel
Copy link

vercel bot commented Dec 30, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
web-base-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 30, 2024 11:51pm

@cb-heimdall
Copy link
Collaborator

cb-heimdall commented Dec 30, 2024 •
edited
Loading

🟡 Heimdall Review Status

Requirement Status More Info
Reviews 🟡 -1/1
Denominator calculation
Show calculation
1 if user is bot 0
1 if user is external 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

@vercel Vercel
Copy link

vercel bot commented Dec 30, 2024

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

A member of the Team first needs to authorize it.

@DeVikingMark DeVikingMark changed the title Update quickstart.md docs: Improve quickstart guide formatting and environment setup clarity Dec 30, 2024
wbnns
wbnns reviewed Dec 30, 2024
View reviewed changes
apps/base-docs/docs/building-with-base/quickstart.md Outdated
@@ -79,8 +79,8 @@ Let's set up both of these:
2. Add the Base network RPC URL to your `.env` file

```bash
BASE_RPC_URL="https://mainnet.base.org"
BASE_SEPOLIA_RPC_URL="https://sepolia.base.org"
BASE_RPC_URL=https://mainnet.base.org
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please drop this change; we prefer to use quotes in this context

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please drop this change; we prefer to use quotes in this context

did it ✅

wbnns
wbnns requested changes Dec 30, 2024
View reviewed changes
Copy link
Member

@wbnns wbnns left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@DeVikingMark

Thanks for this PR! Left a nit in-line.

@wbnns wbnns added change(s) requested One or more changes have been requested base docs review To be reviewed by the Base docs team labels Dec 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wbnns wbnns wbnns requested changes

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
base docs review To be reviewed by the Base docs team change(s) requested One or more changes have been requested
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@DeVikingMark @cb-heimdall @wbnns