First pass of features
This commit is contained in:
@@ -0,0 +1,23 @@
|
||||
---
|
||||
description: Keep env.example and readme.md documentation in sync
|
||||
globs: env.example,readme.md,**/env.example,**/readme.md
|
||||
alwaysApply: true
|
||||
---
|
||||
|
||||
## env.example and readme.md
|
||||
|
||||
The tracked environment template is `env.example` at the project root (the install wizard parses it; `.env` is local and gitignored).
|
||||
|
||||
**Whenever you add, remove, or rename a variable in `env.example`, you must update `readme.md`** — specifically the **Environment variables** (or equivalent) section.
|
||||
|
||||
For each key in `env.example`, the readme must explain:
|
||||
|
||||
- What the value is for
|
||||
- **Where and how a user should obtain** that value (which product UI, console path, or short steps). Prefer stable patterns such as “Google Cloud Console → APIs & Services → Credentials” rather than fragile deep links where possible; official docs links are fine.
|
||||
|
||||
**Also update the readme when:**
|
||||
|
||||
- Install or env-related behavior changes (e.g. `install.php`, redirects, CLI vs web)
|
||||
- New sections in `env.example` (mirror with a readme subsection and user-facing guidance)
|
||||
|
||||
Do not leave new `env.example` keys undocumented in the readme. The install wizard only reflects `env.example`; human-readable acquisition steps live in the readme.
|
||||
Reference in New Issue
Block a user