docs: propagate media facet + fix stale provider reference in VitePress site#77
Merged
Merged
Conversation
…ss site
Audit of the docs LAYER after the media-tools + capability-aware-listing
releases. `vitepress build` passes clean (no dead links); these fix
consistency/completeness gaps the per-PR edits missed:
- reference/providers.md (canonical RepoProvider reference):
- add `media?: MediaProvider` to the interface listing + a Media facet
section documenting MediaProvider and the media asset/input types
- fix `mergeBranch` signature (missing `opts?: { removeSourceBranch? }`)
and MergeResult (missing `remote?` cleanup outcome) — both stale since
the merge-source-delete opt-in change, never documented
- packages/types.md: add the six media types to the Provider Contract
Types catalog; update RepoProvider + MergeResult row descriptions
- guides/providers.md: correct the localWorktree capability row
(was `init/scaffold/.../bulk`; those gate on projectRoot, not the
capability) to match TOOL_REQUIREMENTS + the embedding guide, add the
projectRoot + media-facet gating notes
- packages/cli.md: clarify stdio serves the 19 core tools (media needs a
media-capable provider) — drop the dangling "Same 19 tools"
Docs site is private (not published), so no changeset.
✅ Deploy Preview for contentrain-ai ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
1 participant
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.
Summary
Docs-layer audit after the media-tools (#75) and capability-aware-listing (#73) releases.
vitepress buildpasses clean (no dead links) both before and after — these are consistency/completeness gaps the per-PR edits didn't reach, found by sweeping the whole site rather than just the files each feature PR touched.What was missing / wrong
reference/providers.md— the canonicalRepoProviderreference (biggest gap):mediaBaseUrl?but not the newmedia?: MediaProviderfacet, and no documentation of theMediaProvidercontract or media asset/input types at all.mergeBranchsignature was stale — missingopts?: { removeSourceBranch?: boolean }.MergeResultwas missing theremote?cleanup outcome.(The last two have been stale since the merge-source-delete opt-in change shipped — never documented.)
packages/types.md: the Provider Contract Types catalog listed none of the six new media types;RepoProviderandMergeResultrow descriptions were stale.guides/providers.md: thelocalWorktreecapability row listedinit, scaffold, …, bulk— but after capability-aware listing those gate on a localprojectRoot, not thelocalWorktreecapability. Corrected to matchTOOL_REQUIREMENTSand the embedding guide, and added the projectRoot + media-facet gating notes.packages/cli.md: dropped the dangling "Same 19 tools" for stdio → clarified it serves the 19 core tools (media needs a media-capable provider).Verified consistent
vitepress build→ clean, no dead links, sitemap OK.packages/sdk.md(from feat(sdk): CDN bundle preload mode for @contentrain/query #70).MediaProvidernow documented in reference, types, and both relevant guides; capability matrices inguides/providers.mdandguides/embedding-mcp.mdnow agree.Docs site is
private: true(not published), so no changeset.🤖 Generated with Claude Code