mark legacy cofhejs pages with deprecation warning#25
Draft
roeezolantz wants to merge 1 commit into
Draft
Conversation
Add a Warning callout at the top of every page under the cofhejs tab, linking to the matching @cofhe/sdk replacement page and the migrating-from-cofhejs guide. The pages stay in the nav for projects that haven't migrated yet but make the SDK-vs-cofhejs choice explicit. Co-authored-by: multica-agent <github@multica.ai>
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.
Summary
cofhejsis the legacy client library — superseded by@cofhe/sdk, with a full migration guide already at/client-sdk/introduction/migrating-from-cofhejs. The currentcofhejs/*pages don't say anything about being legacy, so users landing there from search or external links have no idea the API has moved.This is a minimal-risk fix: add a
<Warning>callout to the top of every page under thecofhejs/tree, pointing at the equivalent@cofhe/sdkpage and the migration guide. The pages themselves stay (the tab remains indocs.json) so existing projects oncofhejsaren't stranded.This covers gap A-6 from the docs audit on XDL-11.
Where the underlying change was made
cofhejswas renamed and reshipped as@cofhe/sdk@0.1.0— cofhesdk CHANGELOG0.1.0— `a83facb` & `8d41cf2`. Direct quote: "Prepare for initial release. Rename scope from@cofhesdkto@cofheand renamecofhesdkpackage to@cofhe/sdk." Every release since has been on the@cofhe/*packages; the standalonecofhejspackage on npm is frozen.Changes
Same
<Warning>block added at the top of all 9 cofhejs pages, with the per-page link aimed at the most relevant@cofhe/sdkreplacement:cofhejs/introduction/overview.mdx/client-sdk/introduction/overviewcofhejs/introduction/installation.mdx/client-sdk/introduction/installationcofhejs/introduction/mental-model.mdx/client-sdk/introduction/mental-modelcofhejs/guides/encryption.mdx/client-sdk/guides/encrypting-inputscofhejs/guides/error-handling.mdx/client-sdk/guides/error-handlingcofhejs/guides/permits-management.mdx/client-sdk/guides/permitscofhejs/guides/sealing-unsealing.mdx/client-sdk/guides/decrypt-to-view(sealing/unsealing is internal in the new SDK —decryptForView/decryptForTxhandle it)cofhejs/examples/end-to-end.mdx/client-sdk/examples/end-to-endcofhejs/resources/templates.mdx/client-sdk/examples/templatesEvery Warning also links to
/client-sdk/introduction/migrating-from-cofhejsfor the side-by-side mapping.Out of scope (intentional)
cofhejstab from `docs.json`. The audit recommended this as a possible follow-up step, but it's a bigger UX call (does the team want to keep the tab visible at all?). The Warning is the lighter, reversible step.Test plan