Skip to content

Add docs for client environment variables and their effect on runtime behaviour #562

Description

@Chucks1093

Summary

The client reads several environment variables at build time but none of them are documented. New contributors have to grep the codebase to find which variables exist and what they control. A reference doc should list every variable with its name, purpose, required/optional status, and default value.

Scope

  • List all VITE_ environment variables consumed by the client
  • For each: variable name, description of what it controls, whether it is required or optional, default value if optional
  • Add a note on how to set up a local .env file from the .env.example
  • Document which variables are build-time only versus referenced at runtime

Acceptance Criteria

  • All VITE_ variables listed with name, description, required/optional, and default
  • Build-time vs runtime distinction noted
  • .env setup instructions included
  • Document lives in docs/ and is linked from the local setup guide

ETA: 12 hours


Coordinate on Telegram

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions