Skip to content

[Cleanup]: Decide whether internal docs/specs belong in the public CLI repo #151

@Fermionic-Lyu

Description

@Fermionic-Lyu

Summary

The public CLI repo contains internal planning/spec documents under docs/specs. They may be useful historically, but they read more like implementation planning artifacts than maintained user or contributor docs.

For repo cleanup, we should decide whether these belong in the public CLI repo, should move to Notion/internal docs, or should be promoted into maintained public documentation.

Validation

Valid. docs/specs currently contains three dated design/implementation-plan files.

Relevant Code

  • docs/specs/2026-03-27-diagnose-command-design.md
  • docs/specs/2026-03-27-diagnose-implementation-plan.md
  • docs/specs/2026-04-17-db-migrations-command-design.md

Proposed Solution

Audit each spec and choose one of:

  • Move internal planning content out of the public repo.
  • Archive it in a clearly named historical folder.
  • Convert still-relevant content into maintained README/DEVELOPMENT documentation.

Acceptance Criteria

  • Public docs contain only maintained user/contributor documentation or clearly marked historical material.
  • Any moved content is preserved somewhere appropriate if it is still needed.
  • docs/specs does not look like the current source of truth unless maintainers intend it to be.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions