Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Docs describe removed code: rules/catalog.py, main.py/baseline-mcp, check adapters, darnit.plugins entry-point group

Open
  • Is something wrong?
#488 2 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
48/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
python
Domain
documentation

Research direction

Start by comparing the cited documentation with the current package layout and the evidence at SHA 032493b; the issue names CLAUDE.md, the constitution, framework-design.md, and several guides. Check the constitution’s amendment process and coordinate with the dead-code cleanup issue, as suggested. Done means stale paths, commands, plugin mechanisms, and TOML locations are corrected or clearly marked historical, with any CI guard scoped to removed paths.

Written by the indexing model from the issue text.

Description

documentation good first issue quality

Summary

Contributor-facing and governance docs on main still describe modules, entry points, and file layouts that no longer exist. Some of these docs are cited as authoritative (CLAUDE.md, the constitution, framework-design.md), so new contributors and coding agents follow them.

Impact

Plugin authors copy dead patterns (adapters, get_rules_catalog, TOML outside src/). Two of the examples contradict the feature 021 rule on framework TOML location. The SARIF/catalog sync rule in CLAUDE.md enforces against a file that was deleted in 7985340.

Evidence (SHA 032493b)

rules/catalog.py (removed in 7985340; darnit_baseline/rules/ no longer exists):

  • CLAUDE.md:27 (package tree lists rules/), :239, :250-252
  • .specify/memory/constitution.md:154, :256
  • docs/architecture/framework-design.md:1020
  • ARCHITECTURE.md:116, :519
  • docs/MIGRATION_GUIDE.md:115
  • docs/SARIF_DESIGN.md:16, 286-300, 372, 447 (main.py, baseline_mcp/, rules_catalog.py)

Pre-rename main.py / baseline-mcp layout:

  • docs/USAGE_GUIDE.md:23, 46-47, 62, 73, 396 (clone yourorg/baseline-mcp, python main.py)
  • docs/DECISION_FLOWS.md:1555-1591 (functions "in main.py", project.toml, ToolRegistry.get_check_adapter, BuiltinCheckAdapter), plus diagrams at :800-890, :1468-1470
  • User-facing strings: attestation/signing.py:90 and attestation/__init__.py:40 say pip install baseline-mcp[attestation] (the extra lives on darnit-core)

Adapter system / unused protocol methods (see the dead-code cleanup issue):

  • CLAUDE.md:73-76, ARCHITECTURE.md:383-384, docs/IMPLEMENTATION_GUIDE.md:287-309, 360-363, 1772, docs/tutorials/create-new-implementation.md:214
  • docs/plugin-discovery-design.md:19, 94-106, docs/SECURITY_GUIDE.md:161 (CheckAdapter subclassing)

Nonexistent plugin mechanisms:

TOML location contradicting feature 021 (CLAUDE.md:145):

  • CLAUDE.md:121 (Path(__file__).parent), core/plugin.py:110 docstring, docs/IMPLEMENTATION_GUIDE.md:369, docs/tutorials/create-new-implementation.md:222 (Path(__file__).parent.parent.parent)

Reproduction

ls packages/darnit-baseline/src/darnit_baseline/rules (no such directory); grep -rn "darnit.plugins\"" packages (no match); git grep -n "main.py" docs/USAGE_GUIDE.md.

Suggested direction

Delete or archive USAGE_GUIDE.md, DECISION_FLOWS.md, SARIF_DESIGN.md (or mark historical); fix the CLAUDE.md / constitution / framework-design references in one PR (constitution change follows its own amendment process); land after the dead-code cleanup so docs and code change together. Consider a CI grep guard for removed paths.

Dominant language
Python
Stars
22
Forks
27
Avg merge
1d 20h
Merged PRs (30d)
39

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from darnitdevorg/darnit

All issues in darnitdevorg/darnit

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.