Skip to content

Fix doc drift: load-rule-pack.md says "four" first-party rule packs but Fathom ships five (missing ssvc) #123

Description

@se-jo-ma

Context

Fathom registers five first-party rule packs under the fathom.packs entry-point group in pyproject.toml, but the "Packs shipped with Fathom" section of the load-rule-pack how-to still describes only four. The ssvc pack is missing from both the count and the bullet list, even though it ships on disk (src/fathom/rule_packs/ssvc/) and is registered as an entry point.

Task

Update the "Packs shipped with Fathom" section of docs/how-to/load-rule-pack.md so the count reads "five" and the bullet list includes ssvc alongside the existing four. Names must exactly match the entry-point names in pyproject.toml.

Where

  • docs/how-to/load-rule-pack.md:111 — currently: "Fathom currently ships four first-party rule packs, registered under the same entry-point group in its own pyproject.toml:"
  • docs/how-to/load-rule-pack.md:114-117 — bullet list is owasp-agentic, nist-800-53, hipaa, cmmc (no ssvc).
  • Ground truth: pyproject.toml:144-149 registers owasp-agentic, ssvc, nist-800-53, hipaa, cmmc.

Do NOT touch docs/llms-full.txt (it has the same stale text at line 1533 but is a generated artifact — regenerated by scripts/, see Makefile docs-gen).

Acceptance criteria

  • The sentence at docs/how-to/load-rule-pack.md:111 says "five" (not "four") first-party rule packs.
  • The bullet list under that heading includes ssvc alongside the other four.
  • The five names exactly match the entry-point names in pyproject.toml:145-149 (owasp-agentic, ssvc, nist-800-53, hipaa, cmmc).
  • No other files edited (in particular, do not edit docs/llms-full.txt).

First-timer notes

Start by opening docs/how-to/load-rule-pack.md and jumping to line 109 (the ### Packs shipped with Fathom heading). Change "four" to "five" on line 111 and add a - + backtick-quoted ssvc bullet to the list (lines 114-117). Cross-check against pyproject.toml:144-149 for the exact spelling. This is a two-line text edit with no code or test changes. If you want to confirm the doc renders cleanly, run uv run mkdocs serve (or make docs-serve) and view the load-rule-pack page.

Size: XS

Metadata

Metadata

Assignees

No one assigned

    Labels

    P3Low priority: doc hygiene, cosmetic, sweepdocumentationDocumentation improvementsgood first issueGood for newcomers — scoped, no deep codebase knowledge neededhelp wantedMaintainers would welcome a contributor hererule-packRelated to OWASP/NIST/HIPAA/CMMC rule packssize/XS<1hr: trivial fix or doc tweak

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions