Skip to content

docs(config): deprecate MESSAGING_CWD guidance - #22050

Closed
helix4u wants to merge 1 commit into
NousResearch:mainfrom
helix4u:docs/deprecate-messaging-cwd-references
Closed

docs(config): deprecate MESSAGING_CWD guidance#22050
helix4u wants to merge 1 commit into
NousResearch:mainfrom
helix4u:docs/deprecate-messaging-cwd-references

Conversation

@helix4u

@helix4u helix4u commented May 8, 2026

Copy link
Copy Markdown
Contributor

What does this PR do?

Updates docs that still told users to configure gateway working directories with MESSAGING_CWD. The canonical setting is now terminal.cwd in ~/.hermes/config.yaml; MESSAGING_CWD and direct TERMINAL_CWD env entries are documented only as deprecated compatibility fallbacks.

The source of truth for this docs change is the current implementation:

  • hermes_cli/config.py notes that MESSAGING_CWD was removed from setup and that users should use terminal.cwd in config.yaml instead.
  • hermes_cli/config.py::warn_deprecated_cwd_env_vars() warns when MESSAGING_CWD or direct TERMINAL_CWD is set in .env, and describes both as deprecated migration fallbacks.
  • gateway/run.py treats terminal.cwd bridged through TERMINAL_CWD as canonical, while accepting MESSAGING_CWD only as a deprecated backward-compatibility fallback.

Related Issue

N/A - docs cleanup from support triage.

Type of Change

  • 🐛 Bug fix (non-breaking change that fixes an issue)
  • ✨ New feature (non-breaking change that adds functionality)
  • 🔒 Security fix
  • 📝 Documentation update
  • ✅ Tests (adding or improving test coverage)
  • ♻️ Refactor (no behavior change)
  • 🎯 New skill (bundled or hub)

Changes Made

  • Updated cli-config.yaml.example and the main configuration/security/worktree docs to point users at terminal.cwd.
  • Marked MESSAGING_CWD and direct TERMINAL_CWD env usage as deprecated compatibility fallbacks in the env var reference.
  • Removed stale MESSAGING_CWD labels from Nix and migration docs where they described user-facing working directory setup.
  • Adjusted plugin and cron docs to avoid presenting TERMINAL_CWD as the public configuration surface.

How to Test

  1. rg -n "MESSAGING_CWD|TERMINAL_CWD" README.md cli-config.yaml.example website/docs optional-skills/migration/openclaw-migration/SKILL.md -S
  2. git diff --check

Full pytest suite not run; this is a docs-only change.

Checklist

Code

  • I've read the Contributing Guide
  • My commit messages follow Conventional Commits (fix(scope):, feat(scope):, etc.)
  • I searched for existing PRs to make sure this isn't a duplicate
  • My PR contains only changes related to this fix/feature (no unrelated commits)
  • I've run pytest tests/ -q and all tests pass
  • I've added tests for my changes (required for bug fixes, strongly encouraged for features)
  • I've tested on my platform: WSL/Linux docs checkout

Documentation & Housekeeping

  • I've updated relevant documentation (README, docs/, docstrings) — or N/A
  • I've updated cli-config.yaml.example if I added/changed config keys — or N/A
  • I've updated CONTRIBUTING.md or AGENTS.md if I changed architecture or workflows — or N/A
  • I've considered cross-platform impact (Windows, macOS) per the compatibility guide — or N/A
  • I've updated tool descriptions/schemas if I changed tool behavior — or N/A

Screenshots / Logs

N/A.

@helix4u
helix4u marked this pull request as ready for review May 8, 2026 19:38
@alt-glitch alt-glitch added type/docs Documentation improvements area/config Config system, migrations, profiles comp/cli CLI entry point, hermes_cli/, setup wizard P3 Low — cosmetic, nice to have labels May 11, 2026
@teknium1

Copy link
Copy Markdown
Contributor

This is already implemented on current main.

Automated hermes-sweeper review found the docs cleanup from this PR in commit 119390a2a1eeb47a9b59d29e4158cfd31ae63e1f, which is contained in v2026.6.5.

Evidence:

  • website/docs/user-guide/configuration.md:1803 now documents the messaging gateway working directory as terminal.cwd from ~/.hermes/config.yaml.
  • website/docs/user-guide/configuration.md:1813 now describes MESSAGING_CWD and direct TERMINAL_CWD entries as legacy compatibility fallbacks.
  • website/docs/reference/environment-variables.md:207 marks TERMINAL_CWD as a deprecated direct override and points users to terminal.cwd.
  • website/docs/reference/environment-variables.md:438 marks MESSAGING_CWD as a deprecated compatibility fallback.
  • git show 119390a2a shows the same 12-file documentation update from this PR on main.

Thanks for the cleanup — it made it onto main, so this PR can be closed as implemented.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/config Config system, migrations, profiles comp/cli CLI entry point, hermes_cli/, setup wizard P3 Low — cosmetic, nice to have sweeper:implemented-on-main Sweeper: behavior already present on current main type/docs Documentation improvements

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants