Skip to content

Point five stale doc paths at the moved files - #6388

Merged
blkt merged 1 commit into
stacklok:mainfrom
melbinjp:docs-stale-paths
Aug 24, 2026
Merged

blkt merged 1 commit into
stacklok:mainfrom
melbinjp:docs-stale-paths

Conversation

@melbinjp

Copy link
Copy Markdown
Contributor

Five documented paths point at files that moved. Git recorded all five as renames, so there
is no judgement in this one: each destination verified present and each source verified
absent at 0b8acf26.

document says actually
docs/server/README.md:27 docs/swagger.json docs/server/swagger.json
docs/server/README.md:28 docs/swagger.yaml docs/server/swagger.yaml
docs/server/README.md:29 docs/docs.go docs/server/docs.go
docs/operator/virtualmcpserver-observability.md:27 pkg/vmcp/server/telemetry.go pkg/vmcp/internal/backendtelemetry/backendtelemetry.go
docs/telemetry-migration-guide.md:250 pkg/vmcp/server/telemetry.go same

The first three moved together in 0da4f9a8 ("refactor: openapi, add readme", #448), and the
README that names them is itself in docs/server/ - it points one directory up at its own
neighbours. The other two moved in 87fa2ac8 ("Implement stateless core VMCP constructor",
#5457).

Five lines, three files, no prose changes.

Part of #6387. The other ten findings there are not in this pull request on purpose: they are
subsystems that left for toolhive-core, code removed as dead, and a feature that no longer
exists, and the right fix for each is a judgement from inside the project rather than a patch
from outside.

Found by docproof, a documentation checker that
resolves documented paths against the repository and its git history.

Three of them are in docs/server/README.md, which is itself in docs/server/
and names its own neighbours one directory up: swagger.json, swagger.yaml
and docs.go moved together in 0da4f9a (stacklok#448).

The other two name pkg/vmcp/server/telemetry.go, which became
pkg/vmcp/internal/backendtelemetry/backendtelemetry.go in 87fa2ac (stacklok#5457).

Git recorded all five as renames, so each destination is verified present
and each source verified absent at 0b8acf2. No prose changes.

Part of stacklok#6387, which lists ten more that need a judgement from inside the
project rather than a patch from outside.

Signed-off-by: Melbin J Paulose <melbinjpaulose@gmail.com>
@blkt
blkt force-pushed the docs-stale-paths branch from 5d24c01 to f6672b0 Compare August 24, 2026 16:07
@codecov

codecov Bot commented Aug 24, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.72%. Comparing base (dd0ea20) to head (f6672b0).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #6388      +/-   ##
==========================================
+ Coverage   77.71%   77.72%   +0.01%     
==========================================
  Files         759      759              
  Lines       72889    72889              
==========================================
+ Hits        56646    56655       +9     
+ Misses      16238    16229       -9     
  Partials        5        5              

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@blkt
blkt merged commit 63d2522 into stacklok:main Aug 24, 2026
40 checks passed
@github-actions github-actions Bot mentioned this pull request Aug 26, 2026
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants