Skip to content

Add use-case descriptions to Types section on Variables overview page#499

Open
forzatogo wants to merge 1 commit intousebruno:mainfrom
forzatogo:update-variables-overview
Open

Add use-case descriptions to Types section on Variables overview page#499
forzatogo wants to merge 1 commit intousebruno:mainfrom
forzatogo:update-variables-overview

Conversation

@forzatogo
Copy link

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:

  • New users adding their first variable
  • Users choosing between similar-sounding types (Environment vs Global Environment)
  • Developers deciding between Environment Variables and Process Environment Variables for secrets

Solution

Added concise use-case descriptions to each variable type while preserving the existing structure. Each type now includes:

  • A description of when to use it
  • The link to detailed documentation

Changes

  • Added use-case descriptions to all 7 core variable types
  • Added use-case description and context to Process Environment Variables
  • Reordered the 7 core types to match the precedence shown in the existing diagram on the page, for consistency
  • Clarified that Process Environment Variables are stored in .env files

Impact

  • Users can identify the right variable type without leaving the overview page
  • Improves first-session experience for new users
  • Maintains compatibility with existing documentation structure

Testing

Tested locally with npm run dev - renders correctly, all links work, formatting matches existing page style.

- 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
@vercel
Copy link

vercel bot commented Dec 21, 2025

@forzatogo is attempting to deploy a commit to the Bruno Team on Vercel.

A member of the Team first needs to authorize it.

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