Skip to content

add more info for documentation in AGENTS.md#21498

Merged
adfoster-r7 merged 2 commits into
rapid7:masterfrom
h00die:add_docs_to_agents
May 28, 2026
Merged

add more info for documentation in AGENTS.md#21498
adfoster-r7 merged 2 commits into
rapid7:masterfrom
h00die:add_docs_to_agents

Conversation

@h00die
Copy link
Copy Markdown
Contributor

@h00die h00die commented May 25, 2026

While going over what Claude produced for #21497 I noticed the markdown docs used a table for options, and included a reference section which is not needed. I don't remember if I copied my module output to the markdown docs, Claude took my output from a session and put them in the docs, or hallucinated them. They were getting replaced anyway, so it didn't matter, but we want to also make sure that section is filled out by a human always. @bwatters-r7 previously noted screenshots should be human created, this falls in the same category.

This PR attempts to enhance AGENTS.md to:

  1. include the doc folder
  2. specify the module doc template so docs won't go off the rails with its own format (or use old/bad docs)
  3. put in a mention that AI should never generate the proof section

@h00die
Copy link
Copy Markdown
Contributor Author

h00die commented May 25, 2026

Update, during #21499 claude wrote the scenarios section and made everything up. so we DEFINITELY need to prevent that

@github-project-automation github-project-automation Bot moved this from Todo to In Progress in Metasploit Kanban May 28, 2026
@adfoster-r7 adfoster-r7 merged commit 4e0891f into rapid7:master May 28, 2026
18 checks passed
@github-project-automation github-project-automation Bot moved this from In Progress to Done in Metasploit Kanban May 28, 2026
@adfoster-r7 adfoster-r7 added the rn-no-release-notes no release notes label May 28, 2026
@adfoster-r7 adfoster-r7 self-assigned this May 28, 2026
@h00die h00die deleted the add_docs_to_agents branch May 28, 2026 14:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

rn-no-release-notes no release notes

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants