Add use-case descriptions to Types section on Variables overview page#499
Open
forzatogo wants to merge 1 commit intousebruno:mainfrom
Open
Add use-case descriptions to Types section on Variables overview page#499forzatogo wants to merge 1 commit intousebruno:mainfrom
forzatogo wants to merge 1 commit intousebruno:mainfrom
Conversation
- Adds use-case descriptions to help users choose the right variable type - Reorders types to match existing precedence diagram - Clarifies Process Environment Variables are for secrets in .env files - Reduces decision paralysis for new users
|
@forzatogo is attempting to deploy a commit to the Bruno Team on Vercel. A member of the Team first needs to authorize it. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add use-case descriptions to Types section on Variables overview page
Summary
Enhances the "Types" section of the Variables overview page by adding brief use-case descriptions to each variable type, helping users quickly identify which type they need without clicking through to every page.
Problem
The current Types section lists variable types as simple bullet points with no context about when to use each one. Users must click through several different pages to understand which variable type fits their use case. This creates friction, especially for:
Solution
Added concise use-case descriptions to each variable type while preserving the existing structure. Each type now includes:
Changes
.envfilesImpact
Testing
Tested locally with
npm run dev- renders correctly, all links work, formatting matches existing page style.