Skip to content

docs(security): fix secret redaction default docs - #21621

Closed
helix4u wants to merge 2 commits into
NousResearch:mainfrom
helix4u:docs/redact-secrets-default
Closed

docs(security): fix secret redaction default docs#21621
helix4u wants to merge 2 commits into
NousResearch:mainfrom
helix4u:docs/redact-secrets-default

Conversation

@helix4u

@helix4u helix4u commented May 8, 2026

Copy link
Copy Markdown
Contributor

What does this PR do?

Updates stale documentation that still described security.redact_secrets as disabled by default.

Hermes now defaults secret redaction on, so this PR aligns the configuration guide, bundled Hermes-agent skill source and generated skill page, and the agent.redact helper docstring with the current default.

Related Issue

Docs drift from #17691 / #20785.

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 website/docs/user-guide/configuration.md to show redact_secrets: true as the default and explain when to disable it.
  • Updated skills/autonomous-ai-agents/hermes-agent/SKILL.md so the source skill no longer tells agents that redaction is off by default.
  • Updated website/docs/user-guide/skills/bundled/autonomous-ai-agents/autonomous-ai-agents-hermes-agent.md to match the source skill.
  • Updated the agent/redact.py helper docstring to match the current default.

How to Test

  1. git diff --check

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: N/A, docs/docstring only

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

For New Skills

N/A.

Screenshots / Logs

git diff --check passed.

@alt-glitch alt-glitch added type/docs Documentation improvements comp/agent Core agent runtime: loop, agent_init, prompt builder, context-compression, responses endpoint area/config Config system, migrations, profiles P3 Low — cosmetic, nice to have labels May 8, 2026
@helix4u
helix4u marked this pull request as ready for review May 8, 2026 02:10
@teknium1

Copy link
Copy Markdown
Contributor

This is already implemented on current main.

Automated hermes-sweeper review evidence:

  • hermes_cli/config.py:2029 sets the actual default to "redact_secrets": True.
  • website/docs/user-guide/configuration.md:1661 documents redact_secrets: true as on by default.
  • skills/autonomous-ai-agents/hermes-agent/SKILL.md:456 and website/docs/user-guide/skills/bundled/autonomous-ai-agents/autonomous-ai-agents-hermes-agent.md:473 both say secret redaction is on by default.
  • agent/redact.py:330 documents that redaction is enabled by default and disabled with security.redact_secrets: false.
  • The corresponding main commits are aef04b2b537fbd37b465a4dccc45096af5e73229 and 3625dbb8442c357b1995e9fa750498dd697ba38b, both contained in v2026.6.5.

Thanks for catching and fixing the docs drift.

@teknium1 teknium1 closed this Jun 11, 2026
@teknium1 teknium1 added the sweeper:implemented-on-main Sweeper: behavior already present on current main label Jun 11, 2026
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/agent Core agent runtime: loop, agent_init, prompt builder, context-compression, responses endpoint 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