docs(console): clarify staging vs production environment setup #613
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Update default service URLs from web3.storage to storacha.network - Explicitly note that staging environment is the default (per .env.tpl) - Add clear section for production environment configuration - Document that up.web3.storage redirects to up.storacha.network - Reorganize environment configuration section for better clarity This helps developers understand which environment they're connecting to by default and how to switch between staging, production, and custom services.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
Clarifies the default environment configuration in Console README and provides clear instructions for staging, production, and custom service setups.
Why
The README previously stated the app connects to
https://up.web3.storageby default, but the actual.env.tpluses the staging environment (https://staging.up.storacha.network). This could confuse developers about which environment they're actually using during development.Research
I verified the current endpoints and their behavior:
https://up.web3.storage→ redirects tohttps://up.storacha.network(production)https://up.storacha.network→ production (did:web:up.storacha.network)https://staging.up.storacha.network→ staging (did:web:staging.up.storacha.network).env.tpldefaults to staging environmentChanges
.env.tpl)up.web3.storageredirects to productionNotes
This is a documentation-only change and does not require a version plan. The changes help developers understand which environment they're connecting to and how to switch between staging, production, and custom services.