Skip to content

docs: refresh developer guides#628

Merged
hugomrdias merged 17 commits intomasterfrom
docs/refresh
Mar 1, 2026
Merged

docs: refresh developer guides#628
hugomrdias merged 17 commits intomasterfrom
docs/refresh

Conversation

@nijoe1
Copy link
Contributor

@nijoe1 nijoe1 commented Feb 24, 2026

Refreshes developer guide documentation to reflect all synapse packages.

  • Update synapse.md to align with current SDK API
  • Fix minor inconsistencies across storage/payment docs
  • Rewrite react-integration to use @filoz/synapse-react hooks
  • Add synapse-core page with @filoz/synapse-core modules usage examples
  • Refactor components page with package selection guidance

@github-project-automation github-project-automation bot moved this to 📌 Triage in FOC Feb 24, 2026
@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Feb 24, 2026

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
synapse-dev 1bb222f Commit Preview URL

Branch Preview URL
Feb 27 2026, 08:24 PM

@socket-security
Copy link

socket-security bot commented Feb 24, 2026

No dependency changes detected. Learn more about Socket for GitHub.

👍 No dependency changes detected in pull request

@rjan90 rjan90 moved this from 📌 Triage to ⌨️ In Progress in FOC Feb 24, 2026
@rjan90 rjan90 added this to the M4.1: mainnet ready milestone Feb 24, 2026
Copy link
Contributor

@snissn snissn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deep-dive review complete. I found and fixed a set of docs API-drift issues in follow-up PR #629 (https://github.com/FilOzone/synapse-sdk/pull/629):\n\n- React guide examples now handle optional wallet address correctly under strict TS settings\n- Storage Context guide examples updated to current options-object download API and valid upload input types\n- Synapse and Synapse Core signatures/examples corrected for current SDK behavior\n\nMergeability status: #628 is CLEAN against master.\n\nRecommendation: once #629 is incorporated into this branch/work (via merge/cherry-pick/rebase), I approve this docs refresh for merge. Without those fixes, I recommend holding merge due to misleading example usage in key developer guides.

@rvagg
Copy link
Collaborator

rvagg commented Feb 26, 2026

#630 also adds session key docs so it could also be reviewed along with this for fit

@nijoe1
Copy link
Contributor Author

nijoe1 commented Feb 27, 2026

@hugomrdias @rvagg

All the fixes mentioned above have been applied.

In addition, I've:

  • Integrated ts-twoslash into the new SP→toSP storage-operations and storage-contexts pages.
  • Added a new "Getting Started" page under Developer Guides to help users choose the right SDK based on their needs.

Suggested follow-ups:
There are a few things I think we should address after this PR most notably, decoupling the storage-contexts page from the split operations page, as storage-contexts has grown quite large and warrants its own dedicated treatment.

I'd recommend we merge this as soon as possible builders are already midway through the 30-day hackathon and need up-to-date docs.

cc: @BigLep

@nijoe1 nijoe1 requested a review from rvagg February 27, 2026 19:56
@github-project-automation github-project-automation bot moved this from ⌨️ In Progress to ✔️ Approved by reviewer in FOC Mar 1, 2026
@hugomrdias hugomrdias merged commit b28d372 into master Mar 1, 2026
4 checks passed
@hugomrdias hugomrdias deleted the docs/refresh branch March 1, 2026 18:13
@github-project-automation github-project-automation bot moved this from ✔️ Approved by reviewer to 🎉 Done in FOC Mar 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: 🎉 Done

Development

Successfully merging this pull request may close these issues.

5 participants