fix(docs): align refreshed guides with current SDK APIs#629
fix(docs): align refreshed guides with current SDK APIs#629
Conversation
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
|
Warning Review the following alerts detected in dependencies. According to your organization's Security Policy, it is recommended to resolve "Warn" alerts. Learn more about Socket for GitHub.
|
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
synapse-dev | 417ba51 | Commit Preview URL Branch Preview URL |
Feb 24 2026, 09:21 PM |
Summary
This PR is a reviewed, merge-ready version of the
docs/refreshwork from #628 with follow-up fixes found during deep-dive API/compile validation.It includes all changes from #628 plus targeted corrections to keep developer-guide examples aligned with the current SDK/Core/React APIs and strict docs compilation.
Why this is needed
During review of #628, several docs examples were semantically or type-level out of sync with the latest APIs (some in non-Twoslash blocks, so they were not initially caught by type checks).
These issues would create confusing copy/paste failures or incorrect guidance even when docs built successfully.
Changes made
docs/src/content/docs/developer-guides/react-integration.mdxuseAccountInfoexample to avoid passingaddress: undefinedunderexactOptionalPropertyTypes.useDataSetsexample to passaddressonly when available.docs/src/content/docs/developer-guides/storage/storage-context.mdxUploadPieceStreamingData(Uint8Array[]) instead ofFile[]forStorageContext.upload.getPieces()returningPieceRecord(printspiece.pieceCid).deletePiece({ piece: ... }).synapse.storage.download({ pieceCid, ... })context.download({ pieceCid, ... })Synapse.createis sync in current API).docs/src/content/docs/developer-guides/synapse.mdgetProviderInfosignature docs tostring | bigint.docs/src/content/docs/developer-guides/synapse-core.mdx0x1) with a valid 32-byte hex key literal for Twoslash correctness.Mergeability and readiness deep-dive
mergeStateStatus: CLEANintomaster.Validation performed
pnpm build(repo root): ✅ passcd docs && pnpm build: ✅ passReviewer notes