docs(env): document decommissioning of testing env and transition of feature flags to git JSON#618
Conversation
…feature flags to git JSON - Remove echo-testing environment from branching_and_releases.md - Add Feature Flags Configuration strategy note to frontend_configuration.md Refs: ECHO-834, ECHO-835
WalkthroughDocumentation updates clarifying the branching and release strategy by removing the Testing environment table entry and streamlining the feature development workflow diagram, while adding guidance on managing public feature flags via git-managed JSON instead of Vercel environment variables. ChangesOperational Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Suggested labels
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning Review ran into problems🔥 ProblemsGit: Failed to clone repository. Please run the Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
Thank you for contributing to Dembrane ECHO! Before we consider your Pull Request, we ask that you sign our Contributor License Agreement (CLA). This is only required for your first Pull Request. Please review the CLA, and sign it by adding your GitHub username to the contributors.yml file. Thanks! |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@echo/docs/branching_and_releases.md`:
- Line 7: In the table rows that currently use bold emphasis (e.g., the row
containing "| **Echo Next** | dashboard.echo-next.dembrane.com | `main` branch
(on merge) | Staging / preview / beta testing |" and the other bolded cell
referenced in the comment), replace the Markdown bold markers with italics (or
plain text) for emphasis, and where an em dash is used replace it with a period
or colon to match style rules; ensure the visible text reads the same aside from
emphasis and punctuation changes (no bold, no —).
In `@echo/docs/frontend_configuration.md`:
- Around line 67-72: Replace the wordy paragraph and bullet list that begin with
"We are transitioning public, non-secret feature flags..." with a single concise
sentence: state that public/non-secret feature flags are stored in a git-tracked
JSON consumed by the frontend, while secrets and platform-specific settings
remain in env files/Vercel; remove jargon and extra rationale. Update the
section that currently mentions "Public feature flags", "git-managed JSON", and
"Vercel environment variables" to this shorter form to improve clarity and
brevity.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: f754a15e-da71-4919-b524-a089e5fe96e2
📒 Files selected for processing (2)
echo/docs/branching_and_releases.mdecho/docs/frontend_configuration.md
| |---|---|---|---| | ||
| | **Testing** | dashboard.testing.dembrane.com | `testing` branch (on push) | Shared, unprotected | | ||
| | **Echo Next** | dashboard.echo-next.dembrane.com | `main` branch (on merge) | Staging / preview | | ||
| | **Echo Next** | dashboard.echo-next.dembrane.com | `main` branch (on merge) | Staging / preview / beta testing | |
There was a problem hiding this comment.
Replace bold emphasis and em dash in the updated docs copy.
Line 7 and Line 23 use bold for emphasis, and Line 23 uses an em dash. Please switch bold emphasis to plain text or italics, and replace the em dash with a period or colon to match the style rules.
Suggested doc edit
-| **Echo Next** | dashboard.echo-next.dembrane.com | `main` branch (on merge) | Staging / preview / beta testing |
+| Echo Next | dashboard.echo-next.dembrane.com | `main` branch (on merge) | Staging / preview / beta testing |
-4. **After merge** — changes auto-deploy to Echo Next (where beta testing is done directly)
+4. After merge: changes auto-deploy to Echo Next (beta testing is done directly)As per coding guidelines, "Never use em dashes (—)" and "Never use bold for emphasis; use Royal Blue (#4169e1) or italics instead."
Also applies to: 23-23
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@echo/docs/branching_and_releases.md` at line 7, In the table rows that
currently use bold emphasis (e.g., the row containing "| **Echo Next** |
dashboard.echo-next.dembrane.com | `main` branch (on merge) | Staging / preview
/ beta testing |" and the other bolded cell referenced in the comment), replace
the Markdown bold markers with italics (or plain text) for emphasis, and where
an em dash is used replace it with a period or colon to match style rules;
ensure the visible text reads the same aside from emphasis and punctuation
changes (no bold, no —).
| > We are transitioning public, non-secret feature flags directly into git-managed JSON inside the code instead of Vercel environment variables. This avoids Vercel lock-in, reduces configuration overhead, and eliminates the mental block of updating environment configurations. | ||
| > | ||
| > In the new strategy: | ||
| > - Public feature flags will live directly in git (e.g., in a JSON config file). | ||
| > - The frontend application will consume this configuration directly from git. | ||
| > - Secrets and platform-specific environment variables will continue to use standard env files/Vercel settings. |
There was a problem hiding this comment.
Tighten feature-flag note to remove jargon and reduce length.
Line 67 to Line 72 are wordy and include jargon. Please keep this section shorter and more direct so setup steps are easier to follow.
Suggested doc edit
-> We are transitioning public, non-secret feature flags directly into git-managed JSON inside the code instead of Vercel environment variables. This avoids Vercel lock-in, reduces configuration overhead, and eliminates the mental block of updating environment configurations.
+> Public non-secret feature flags now live in a JSON file in git, not in Vercel environment variables. This reduces config overhead.
>
> In the new strategy:
-> - Public feature flags will live directly in git (e.g., in a JSON config file).
-> - The frontend application will consume this configuration directly from git.
-> - Secrets and platform-specific environment variables will continue to use standard env files/Vercel settings.
+> - Public feature flags live in git in a JSON config file.
+> - The frontend reads this config from the repository.
+> - Secrets and platform-specific values stay in env files and Vercel settings.As per coding guidelines, documentation must use "shortest possible text, highest clarity, no jargon."
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| > We are transitioning public, non-secret feature flags directly into git-managed JSON inside the code instead of Vercel environment variables. This avoids Vercel lock-in, reduces configuration overhead, and eliminates the mental block of updating environment configurations. | |
| > | |
| > In the new strategy: | |
| > - Public feature flags will live directly in git (e.g., in a JSON config file). | |
| > - The frontend application will consume this configuration directly from git. | |
| > - Secrets and platform-specific environment variables will continue to use standard env files/Vercel settings. | |
| > Public non-secret feature flags now live in a JSON file in git, not in Vercel environment variables. This reduces config overhead. | |
| > | |
| > In the new strategy: | |
| > - Public feature flags live in git in a JSON config file. | |
| > - The frontend reads this config from the repository. | |
| > - Secrets and platform-specific values stay in env files and Vercel settings. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@echo/docs/frontend_configuration.md` around lines 67 - 72, Replace the wordy
paragraph and bullet list that begin with "We are transitioning public,
non-secret feature flags..." with a single concise sentence: state that
public/non-secret feature flags are stored in a git-tracked JSON consumed by the
frontend, while secrets and platform-specific settings remain in env
files/Vercel; remove jargon and extra rationale. Update the section that
currently mentions "Public feature flags", "git-managed JSON", and "Vercel
environment variables" to this shorter form to improve clarity and brevity.
1 participant
What changes in the system
Testingenvironment (dashboard.testing.dembrane.com) from documentation. We now do beta testing directly onEcho Next. —echo/docs/branching_and_releases.mdecho/docs/frontend_configuration.mdRefs: ECHO-834, ECHO-835
Summary by CodeRabbit