docs: stop publishing the internal plans directory on a public repo - #159
Merged
Merged
Conversation
Three source comments and one CI comment cited paths under docs/simple_someip/plans/. The surrounding prose already carries the reasoning; the citations only pointed a public reader at documents written for us. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Eight design and plan documents written for ourselves — internal phase sequencing, internal PR numbers, our own refactoring reasoning — on the default branch of a public repository, and inside every published crate tarball (the package has no `include`/`exclude`, so `cargo package` picks the directory up). .gitignore has listed the path since before these landed; the files predate the rule and .gitignore does not apply to tracked files. With them gone the existing rule keeps them gone. This stops the publishing. It does not redact: the documents remain in this repository's git history and in crates.io releases already cut. Closes #158 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## main #159 +/- ##
=======================================
Coverage 81.72% 81.72%
=======================================
Files 48 48
Lines 16178 16178
=======================================
Hits 13222 13222
Misses 2956 2956
|
JustinKovacich
marked this pull request as ready for review
September 14, 2026 20:41
zheylmun
approved these changes
Sep 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #158.
mainon this public repository carrieddocs/simple_someip/plans/— eightdesign and plan documents written for ourselves, named by internal phase and
pull-request number. This removes them.
What the PR does
docs: drop the in-repo pointers into the internal plans directory— fourcitations of paths under
docs/simple_someip/plans/(three source comments,one CI comment) removed, so nothing is left pointing at files that no longer
exist. The surrounding prose already carried the reasoning; the citations only
told a public reader where our internal documents live. One of them — the
future-size budget comment in
src/client/mod.rs— also said "compare againstthe baseline", meaning the baseline file; it now points at the constants
immediately below it.
docs: stop publishing docs/simple_someip/plans/ on a public repo— theeight files,
git rm'd.docs/held nothing else, so the directory is gone.Two things worth knowing
They were also inside every published crate.
[package]declares noinclude/exclude(theexcludein the manifest is[workspace]'s, fortools/size_probe), socargo packagepicked the whole directory up.Before:
cargo package --list | grep -c '^docs/'→ 8. After → 0.Someone already decided this, and only half-landed it.
.gitignorehaslisted
docs/simple_someip/plans/since 6925d56 (2026-07-16, "gitignoresuperpowers plan/spec docs; untrack the #142 pair"). That commit untracked the
newer pair and noted that already-tracked plans stay tracked. These eight
landed 2026-06-10 and earlier, so the rule never reached them. With them gone,
the existing rule keeps them gone — no new ignore entry needed.
What this is not
It stops the publishing; it does not redact. The documents remain in this
repository's git history, and in the crates.io releases already cut, which are
immutable. If the goal is that they stop being retrievable rather than that
they stop being browsable, this PR is not enough and the issue thread is the
place to say so.
They also still have value to us. Nothing here preserves a copy anywhere
internal —
git show 0baa3f1:docs/simple_someip/plans/<file>recovers any ofthem if we want to move rather than drop.
Not touched
Cargo.tomlstill cites "the bare_metal_plan_v2 TriCore delta" in a dependencycomment — an internal plan name in a public, published manifest. Same class of
leak, different document, and it is not dangling, so I left it. Worth a
follow-up if we care.
Testing
cargo fmt --all --check— clean.cargo clippy --workspace --no-default-features --features $ALLOC_FEATURES -- -D warnings -D clippy::pedantic— clean (CI's alloc/host lane).RUSTDOCFLAGS=-Dwarnings cargo doc --no-deps --no-default-features --features $ALLOC_FEATURES— clean.cargo package --list— nodocs/entries.Note for anyone running these locally:
--all-featuresdoes not build on thiscrate and never did (
bare-metal-runtimeis nightly and mutually exclusivewith the alloc features) — use the CI feature sets, and include
bare_metalfor the doc build or
bare_metal_taskscfg's out and its intra-doc links fail.Review status
Not yet reviewed by a human.
🤖 Generated with Claude Code