docs: Add comprehensive documentation to .env.example#124
Open
ShashwatpSingh wants to merge 1 commit intoopentagmanager:stagingfrom
Open
docs: Add comprehensive documentation to .env.example#124ShashwatpSingh wants to merge 1 commit intoopentagmanager:stagingfrom
ShashwatpSingh wants to merge 1 commit intoopentagmanager:stagingfrom
Conversation
- Add section headers with visual separators - Document every environment variable with clear descriptions - Mark required vs optional variables - Explain default values and formats - Add security warnings for sensitive keys - Include links to external services (Upstash, OAuth) - Group related variables into logical sections This improves DX for new contributors by making environment setup self-documenting and reducing onboarding friction.
|
@ShashwatpSingh is attempting to deploy a commit to the OSS Tag 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.
Summary
This PR adds comprehensive documentation to
.env.example, making environment setup self-documenting and dramatically improving the developer experience for new contributors.Problem
The existing
.env.examplehad 40+ environment variables with zero documentation. New contributors had to:Solution
Added detailed documentation including:
Structure
Per-Variable Documentation
Security Improvements
Preview
Impact
Testing
Related: This directly addresses the setup friction mentioned in [Discord/onboarding feedback].
No breaking changes - purely additive documentation.