Skip to content

[#7554] Document settings mode env var naming and migration guide#12

Merged
vladzholnerchuk merged 1 commit intomainfrom
docs/7554-settings-legacy-mode
May 8, 2026
Merged

[#7554] Document settings mode env var naming and migration guide#12
vladzholnerchuk merged 1 commit intomainfrom
docs/7554-settings-legacy-mode

Conversation

@vladzholnerchuk
Copy link
Copy Markdown
Contributor

Summary

  • Removes stale "obsolete in July 2025" deadline from the legacy mode description — the deadline has passed and legacy is still the default for existing instances
  • Adds a table explaining the __ vs _ env var separator difference by settings mode
  • Adds a warning callout that renaming env vars from __-style to _-style without switching BOX_SETTINGS_MODE silently breaks configuration
  • Adds a migration stepper for moving from legacy to read-write mode

Note: docs/reference/all-settings.md is auto-generated from sansara — the corresponding fix to the generated content (removing the stale date from the legacy variant description and renaming "Deprecated environment variables" to "Legacy mode environment variable") is in the companion PR at HealthSamurai/sansara.

Test plan

  • Verify the settings mode table renders correctly
  • Verify the warning hint renders correctly
  • Verify the stepper renders correctly
  • Run bun lint — no new errors

Closes #7554

🤖 Generated with Claude Code

- Remove stale "obsolete in July 2025" deadline from legacy mode description
- Add table explaining __ vs _ env var separator by settings mode
- Add warning callout about silent config breakage when renaming env vars
  without switching BOX_SETTINGS_MODE
- Add migration stepper for moving from legacy to read-write mode

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@vladzholnerchuk vladzholnerchuk merged commit 18754b8 into main May 8, 2026
2 checks passed
@vladzholnerchuk vladzholnerchuk deleted the docs/7554-settings-legacy-mode branch May 8, 2026 12:00
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