Skip to content

Keep docs/SPEC.md Project Structure tree in sync with actual internal/ layout #5

Description

@JeremiahChurch

Summary

The "Project Structure" tree in docs/SPEC.md has drifted from the actual repository layout as new packages have been added under internal/. Contributors reading the spec get a misleading picture of the code.

Fix

  1. Walk the current internal/ tree and reconcile it with the tree shown in docs/SPEC.md.
  2. Add missing packages, remove deleted ones, and fix any renamed directories.
  3. Consider trimming the tree to only the top one or two levels so future churn doesn't immediately invalidate it again.

Acceptance criteria

  • Tree in docs/SPEC.md matches internal/ at the level of detail shown.
  • Short note near the tree (or a CONTRIBUTING line) reminding editors to update it when adding/removing a package.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions