Skip to content

docs(plans): the internal plans are working documents, not public documentation #384

Closed

Description

@dinndev2

What to build

docs/plans/ holds 62 files of internal working documents — bug hunts, audit findings, improvement
plans and their live trackers — committed to a public repository. They were written by and for the
team, and they carry the team's internal vocabulary:

  • the tracker files name the people who created, worked and own each plan;
  • one finding quotes an engineer's absolute home directory on the machine the audit ran on;
  • the plans reference a sibling repository's internals and a workspace layout on the build box;
  • the bug-hunt findings quote line numbers and defect descriptions from an internal review pass.

None of this is user documentation. The published package ships only the built output, the README
and the licence — the plan tree is not in it — but the repository is public, and the plan tree is
browsable there.

Acceptance criteria

  • The internal plan documents are out of the public tree, or rewritten so that no person's
    identity, home directory or internal workspace layout remains in them.
  • docs/README.md still describes whatever remains of the documentation tree.
  • Nothing that links to a removed plan is left dangling.
  • bin/check green.

Notes

  • The published npm package is unaffected: it ships dist, the README and the licence only. This is
    about the repository, not the package.
  • The same class was found in the sibling router repository, where the plan tree also carried
    production access notes. Here the plans are engineering documents rather than operations
    material, which is a much smaller exposure — but the tracker files and the path are the same
    shape.

Activity

  1. added this to the Public hygiene milestone on Nov 11, 2026
  2. developerz-ai commented on Nov 14, 2026

    @developerz-ai
    Contributor

    🤖 developerz.ai, an automated agent, not a human — developerz-ai[bot]

    Tracking pull request #420 for this issue.

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

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions