Skip to content

docs: Professionally restructure project README - #22

Merged
m4sh-wacker merged 5 commits into
mainfrom
docs/restructure-readme
Nov 21, 2026
Merged

m4sh-wacker merged 5 commits into
mainfrom
docs/restructure-readme

Conversation

@m4sh-wacker

@m4sh-wacker m4sh-wacker commented Nov 21, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Shortens the README to an overview of detection, recipes, and CTF search. The navigation row sits above the existing showcase video. Development covers the Node.js requirement and npm commands. Standalone Edition explains offline use, main-thread processing, and when to download a fresh copy.

The privacy section explains what a shared recipe contains and when a link includes input. Contributor guidance includes a collapsible source layout. Project Lead and License each have their own section.

Verification

  • Reviewed the complete diff against main. Only README.md changed.
  • Ran Markdown lint, checked the five navigation destinations, and compared the showcase URL with the approved README.
  • Verified 504 distinct operation IDs in the registry. The full test suite passed all 1,205 tests during the README review.

@m4sh-wacker
m4sh-wacker force-pushed the docs/restructure-readme branch from 6738f99 to 53ca7a9 Compare November 21, 2026 09:47
@m4sh-wacker
m4sh-wacker merged commit 2ec92af into main Nov 21, 2026
9 checks passed
@m4sh-wacker
m4sh-wacker deleted the docs/restructure-readme branch November 21, 2026 10:54
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