Skip to content

docs: point nine stale paths at the code that exists - #6650

Open
melbinjp wants to merge 1 commit into
stacklok:mainfrom
melbinjp:docs/point-nine-stale-paths-at-the-moved-code
Open

melbinjp wants to merge 1 commit into
stacklok:mainfrom
melbinjp:docs/point-nine-stale-paths-at-the-moved-code

Conversation

@melbinjp

Copy link
Copy Markdown
Contributor

Closes the rest of #6387, which is assigned to me. #6388 took the five plain renames; these are the nine that needed a decision about what the replacement should say.

Re-measured against e532cf0 rather than re-quoted from the issue. Two things changed since I filed it: one line had moved again, and pkg/skills/feature_gate.go is already gone from the docs, so it is nine rather than the ten I last counted.

Four moved to toolhive-core

The replacement is the import path the Go code uses today, not a guess.

document was now
docs/arch/03-transport-architecture.md pkg/permissions/profile.go toolhive-core/permissions
docs/arch/06-registry-system.md pkg/registry/types.go toolhive-core/registry/types
docs/arch/06-registry-system.md pkg/container/verifier/ toolhive-core/container/verifier
docs/error-handling.md pkg/errors/errors.go toolhive-core/httperr

Two of these are self-evidencing. pkg/runner/retriever/retriever.go imports toolhive-core/container/verifier, and docs/error-handling.md already uses httperr.Code(err) in the example directly above the list that still named pkg/errors.

pkg/registry/schema_validation.go is named as the validator for schemas the same document already says are published in toolhive-core, so it points there too.

Discovery

pkg/vmcp/discovery/ is not in the tree. Discovery is, in pkg/vmcp/aggregator/discoverer.go, so the three references name the aggregator rather than dropping the idea. The vmcp-library.md row is removed: it lists a package that no longer exists, and it already told readers to use it via the aggregator.

One left alone deliberately

docs/arch/10-virtual-mcp-architecture.md still has a Backend Enrichment Middleware section naming pkg/vmcp/server/backend_enrichment.go. That file went in #5622 and nothing in the tree replaces it, so unlike the others this is not a path that moved, it is a section describing something that is gone. Deleting a section is an editorial call rather than a path fix, so I have left it for you. Happy to send it as a one-line follow-up if you would like it removed.

Verification

All four toolhive-core links resolve, and all five in-tree paths are present at e532cf0. Docs only, no code changes.

Follow-up to stacklok#6388, which fixed the five plain renames from stacklok#6387. These are
the rest, re-measured against e532cf0 rather than re-quoted from the issue:
one had moved again since it was filed, and pkg/skills/feature_gate.go is
already gone from the docs, so it is nine rather than ten.

Four moved to toolhive-core, and the replacement is the import path the Go
code uses today:

  pkg/permissions/profile.go  ->  toolhive-core/permissions
  pkg/registry/types.go       ->  toolhive-core/registry/types
  pkg/container/verifier/     ->  toolhive-core/container/verifier
  pkg/errors/errors.go        ->  toolhive-core/httperr

pkg/runner/retriever/retriever.go imports the verifier one, and
docs/error-handling.md already used httperr.Code in the example directly
above the list that still named pkg/errors.

pkg/registry/schema_validation.go is named as the validator for schemas the
same document already says are published in toolhive-core, so it points
there too.

pkg/vmcp/discovery/ is not in the tree. Discovery is, in
pkg/vmcp/aggregator/discoverer.go, so the three references name the
aggregator rather than dropping the idea. The vmcp-library row is removed
because it lists a package that no longer exists and already said to use it
via the aggregator.

Every destination checked at e532cf0: the four toolhive-core links resolve,
and the five in-tree paths are present.

Signed-off-by: Melbin J Paulose <melbinjpaulose@gmail.com>
@codecov

codecov Bot commented Sep 13, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.91%. Comparing base (e532cf0) to head (6b203ba).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #6650      +/-   ##
==========================================
- Coverage   78.98%   78.91%   -0.07%     
==========================================
  Files         782      782              
  Lines       78065    78065              
==========================================
- Hits        61658    61607      -51     
- Misses      16402    16453      +51     
  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.

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.

1 participant