Skip to content

Move module docs to paths matching their modules - #22049

Merged
dwelch-r7 merged 1 commit into
rapid7:masterfrom
protonnegativo:docs/fix-module-doc-paths
Nov 9, 2026
Merged

dwelch-r7 merged 1 commit into
rapid7:masterfrom
protonnegativo:docs/fix-module-doc-paths

Conversation

@protonnegativo

Copy link
Copy Markdown
Contributor

Description

info -d finds a module's documentation at documentation/modules/<module fullname>.md (Msf::Util::DocumentGenerator.get_module_document). These ten docs sit at a path that doesn't match their module, so info -d never shows them. Each one is a pure git mv; no content changes.

Old path New path Why
auxiliary/scanner/http/thinvnc_travesal.md auxiliary/scanner/http/thinvnc_traversal.md typo
auxiliary/dos/siemens_siprotec4.md auxiliary/dos/scada/siemens_siprotec4.md module is in dos/scada
auxiliary/dos/tcp/claymore.md auxiliary/dos/tcp/claymore_dos.md module is claymore_dos
auxiliary/admin/http/epmp1000_get_chart_cmd_exec.md auxiliary/scanner/http/epmp1000_get_chart_cmd_exec.md module is in scanner/http
auxiliary/admin/http/epmp1000_reset_pass.md auxiliary/scanner/http/epmp1000_reset_pass.md module is in scanner/http
exploit/linux/http/epmp1000_get_chart_cmd_shell.md exploit/unix/http/epmp1000_get_chart_cmd_shell.md module is in unix/http
exploit/linux/http/epmp1000_ping_cmd_shell.md exploit/unix/http/epmp1000_ping_cmd_shell.md module is in unix/http
exploit/linux/http/goautodial_3_rce_code_injection.md exploit/linux/http/goautodial_3_rce_command_injection.md module is ..._command_injection
exploit/linux/local/docker_priviledged_container_escape.md exploit/linux/local/docker_privileged_container_escape.md typo
exploits/multi/http/litellm_mcp_test_cmd_injection.md exploit/multi/http/litellm_mcp_test_cmd_injection.md fullname starts with exploit/

Each doc's own Verification Steps already use the new path. None of the target modules had a doc at the new path.

AI tools: Claude (Claude Code) was used to find these mismatches and to suggest how to fix them. Each rename was then verified against the module tree (see Verification).

Verification

  • For each renamed doc, confirmed the module exists at the matching path under modules/ and that no doc already existed at the new path.
  • Ran ruby tools/dev/msftidy_docs.rb on the ten files: only pre-existing warnings (section order, missing Options), same as before the move since content is unchanged.

Results and evidence

git show --stat -M reports 10 renames, 0 insertions, 0 deletions. I did not run info -d in msfconsole.

info -d looks up documentation at
documentation/modules/<module fullname>.md, so these ten docs were
never found: the file name has a typo (travesal, priviledged), a
different name than the module (claymore, code_injection), or the
module lives in another directory (dos/scada, scanner/http,
unix/http, exploit/ instead of exploits/). Content is unchanged.
@coderabbitai

coderabbitai Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

Important

Review skipped

Review was skipped as selected files did not have any reviewable changes.

Files selected but had no reviewable changes: 10
  • documentation/modules/auxiliary/dos/scada/siemens_siprotec4.md
  • documentation/modules/auxiliary/dos/tcp/claymore_dos.md
  • documentation/modules/auxiliary/scanner/http/epmp1000_get_chart_cmd_exec.md
  • documentation/modules/auxiliary/scanner/http/epmp1000_reset_pass.md
  • documentation/modules/auxiliary/scanner/http/thinvnc_traversal.md
  • documentation/modules/exploit/linux/http/goautodial_3_rce_command_injection.md
  • documentation/modules/exploit/linux/local/docker_privileged_container_escape.md
  • documentation/modules/exploit/multi/http/litellm_mcp_test_cmd_injection.md
  • documentation/modules/exploit/unix/http/epmp1000_get_chart_cmd_shell.md
  • documentation/modules/exploit/unix/http/epmp1000_ping_cmd_shell.md
Run configuration
Commits

Reviewing files that changed from the base of the PR and between e25d6ee and e866990.

Files selected for processing: 10
  • documentation/modules/auxiliary/dos/scada/siemens_siprotec4.md
  • documentation/modules/auxiliary/dos/tcp/claymore_dos.md
  • documentation/modules/auxiliary/scanner/http/epmp1000_get_chart_cmd_exec.md
  • documentation/modules/auxiliary/scanner/http/epmp1000_reset_pass.md
  • documentation/modules/auxiliary/scanner/http/thinvnc_traversal.md
  • documentation/modules/exploit/linux/http/goautodial_3_rce_command_injection.md
  • documentation/modules/exploit/linux/local/docker_privileged_container_escape.md
  • documentation/modules/exploit/multi/http/litellm_mcp_test_cmd_injection.md
  • documentation/modules/exploit/unix/http/epmp1000_get_chart_cmd_shell.md
  • documentation/modules/exploit/unix/http/epmp1000_ping_cmd_shell.md

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

@protonnegativo
protonnegativo marked this pull request as ready for review October 24, 2026 02:42
@dwelch-r7 dwelch-r7 added the docs label Nov 9, 2026
@github-project-automation github-project-automation Bot moved this from Todo to In Progress in Metasploit Kanban Nov 9, 2026
@dwelch-r7 dwelch-r7 added the rn-no-release-notes no release notes label Nov 9, 2026
@dwelch-r7
dwelch-r7 merged commit 30e78a8 into rapid7:master Nov 9, 2026
21 checks passed
@github-project-automation github-project-automation Bot moved this from In Progress to Done in Metasploit Kanban Nov 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants