docs: split the two large reference tables out of the README#248
Closed
spierenburg wants to merge 1 commit into
Closed
docs: split the two large reference tables out of the README#248spierenburg wants to merge 1 commit into
spierenburg wants to merge 1 commit into
Conversation
The README had grown to ~85KB / ~450 lines, almost all of it two reference tables: the 200+ matterfeed sources and the 95 matterbot commands. They buried the operational docs (install, run, configure) that a new user actually needs to read first. Move the catalogs into their own files and replace each with a short summary + link in the README: - docs/FEEDS.md — full matterfeed sources table (200+ entries) - docs/COMMANDS.md — full matterbot commands table (95 entries) README drops from ~450 to ~170 lines; the how-to-run sections now sit near the top instead of after 300 rows of tables. No table content was changed — rows were moved verbatim. Also promotes the two section headings from h3 to h2 (they were h3 but sat at top level under "Contents"). Each extracted file keeps a one-line intro and a back-link to the README.
Collaborator
Author
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Restructures the README for readability. It had grown to ~85KB / ~450 lines, almost entirely two reference tables — the 200+
matterfeedsources and the 95matterbotcommands — which buried the operational docs (install / run / configure) a new user needs first.This moves the two catalogs into their own files and replaces each in the README with a short summary + link:
docs/FEEDS.mdmatterfeedsources table (200+ entries)docs/COMMANDS.mdmatterbotcommands table (95 entries)Effect
###to##— they wereh3but sat at top level under "Contents", which made the document outline misleading.← Back to READMElink.Why split files (vs.
<details>blocks or reordering)Collapsing the tables in
<details>or just moving them down keeps the raw file at 85KB and keeps every feed/command edit touching the monster README. Putting the command catalog in its owndocs/COMMANDS.mdalso makes it the natural place to later auto-generate the table from each module'sdefaults.pyHELPblock — which would permanently kill the doc-drift that PR #247 just had to fix by hand. That long-term win is only possible once the table lives on its own.Base branch / relationship to #247
This is stacked on
docs/readme-reconcile(PR #247), notmain, so the diff shows only the restructure — not the 38 table rows added in #247. GitHub will auto-retarget this PR tomainonce #247 merges. (If you'd prefer it rebased directly ontomaininstead, say the word and I'll redo it.)Not included
Deliberately left for a follow-up: regrouping the command "Type" column into a sharper taxonomy (Reputation/Enrichment · Surface Search · OSINT · Vuln Mgmt · …) — ~80 of 95 rows currently say "Threat Intel". That's a content change, separate from this pure move.