Skip to content

docs/simple_someip/plans/ publishes eight internal planning documents on a public repository #158

Description

@JustinKovacich

Found while inventorying the documentation that reaches people outside MicroVision (2026-09-11). Re-verified via the GitHub contents API on 2026-09-14 — the directory is still there.

This repository is public, and main carries docs/simple_someip/plans/: eight design and plan documents written for ourselves, named by internal phase and pull-request number.

2026-06-09-phase22-125-memory-reduction-design.md
2026-06-10-pr1-124-followups-design.md
2026-06-10-pr1-124-followups.md
2026-06-11-128-embassy-union-rebase.md
2026-06-17-pr126-polled-port-handoff.md
2026-06-17-pr2-125-client-async-state-reduction.md
2026-06-17-pr3-125-server-buffer-extraction.md
baselines/pr0-size-baseline.md

Nothing in them was written for an outside reader. They describe internal phase sequencing, internal PR numbers, and our own refactoring reasoning.

Proposal: remove them from the public branch. Two things to be clear about before anyone does:

  • Removing them from main stops casual discovery. It does not remove them from the repository's git history, so this is a "stop publishing" action, not a redaction.
  • They have real value to us. Moving rather than deleting — into an internal location — preserves that.

Raising it as a decision rather than doing it, since "we accept that our internal planning is part of what this repo publishes" is a legitimate answer and is not mine to pick.

Related: the same inventory is tracked in luminartech/dft#1216, #1217, #1218, #1219.

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

    simple_someipIssue related to the simple_someip crate

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions