Skip to content

Tighten README for public audience#3

Merged
monoxgas merged 1 commit intomainfrom
nick/readme-public-pass
May 4, 2026
Merged

Tighten README for public audience#3
monoxgas merged 1 commit intomainfrom
nick/readme-public-pass

Conversation

@monoxgas
Copy link
Copy Markdown
Contributor

@monoxgas monoxgas commented May 4, 2026

Summary

Top-down pass on the README now that the repo is public. Every change is either a contextual mismatch fix or a coverage gap close — voice nits left alone.

  • Replace fictional threat-hunting/ directory tree with a real ai-red-teaming/ shape that matches the install bullets below.
  • Drop workers from the component list — none of the 15 capabilities in this repo ships one.
  • Direct headings (Install one, Build your own) in place of question-form ones; cut the meta "welcome" line and the "great place to be" hype.
  • Add a one-liner pointing readers at getting-started so dn capability install … isn't an unexplained command for anyone landing here cold.
  • Stop claiming "Most are MIT" in the License section — point at each capability's capability.yaml so the README doesn't have to track licensing changes.

Test plan

  • pre-commit run --files README.md passes
  • All linked doc URLs return 200 (docs.dreadnode.io/getting-started/quickstart/, …/capabilities/{installing,overview,manifest,quickstart}/)
  • ai-red-teaming/ and web-security/ referenced in examples exist on disk
  • Skim the rendered README on the PR page to confirm the new flow reads cleanly

🤖 Generated with Claude Code

- Replace fictional `threat-hunting/` example with a real `ai-red-teaming/`
  tree — no capability in this repo was named threat-hunting.
- Drop `workers` from the components list — none of the 15 capabilities
  here ships one.
- Direct headings (`Install one`, `Build your own`) in place of
  question-form ones; cut the meta "welcome" and hype filler.
- Point readers at getting-started so `dn` isn't an unexplained command.
- Stop claiming "Most are MIT" — point at the manifest as source of truth
  so the README doesn't drift if a capability ships under another license.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@monoxgas monoxgas merged commit a1f2f8a into main May 4, 2026
4 checks passed
@monoxgas monoxgas deleted the nick/readme-public-pass branch May 4, 2026 22:42
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