Skip to content

docs: note withCDN option in getting started docs#440

Merged
hugomrdias merged 3 commits into
masterfrom
docs-update/add-filbeam-to-setup
Dec 4, 2025
Merged

docs: note withCDN option in getting started docs#440
hugomrdias merged 3 commits into
masterfrom
docs-update/add-filbeam-to-setup

Conversation

@geomatrick
Copy link
Copy Markdown
Collaborator

Adding a reference to Filecoin Beam in the Synapse getting started guide.

@github-project-automation github-project-automation Bot moved this to 📌 Triage in FOC Nov 14, 2025
@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented Nov 14, 2025

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 d7272de Commit Preview URL

Branch Preview URL
Dec 03 2025, 07:04 PM

Comment on lines +85 to +86
// Uncomment to supercharge retrievability with Filecoin Beam
// withCDN: true
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

its true by default

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Oh great!

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Lets ignore the PR then

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This seems not to be true:

/** Whether to use CDN for retrievals (default: false) */

options.withCDN === true,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

why ? the second line makes it true no ?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The second line checks if it's true? 🤔

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Lol your are right wth is that

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

It just sets the argument to true if it's exaclty true, otherwise it sets it to false. So we're not doing a truthy check, only a strict true check. I don't know why it's like this though.

Anyway, this means that withCDN is off by default, and we can reopen this PR I think

@hugomrdias hugomrdias closed this Nov 14, 2025
@github-project-automation github-project-automation Bot moved this from 📌 Triage to 🎉 Done in FOC Nov 14, 2025
@juliangruber juliangruber reopened this Nov 25, 2025
@github-project-automation github-project-automation Bot moved this from 🎉 Done to ⌨️ In Progress in FOC Nov 25, 2025
@rvagg rvagg changed the title withCDN param in synapse getting started docs docs: note withCDN option in getting started docs Dec 2, 2025
@rvagg
Copy link
Copy Markdown
Collaborator

rvagg commented Dec 2, 2025

I'm fine with this (wording could be more nuanced, but also whatever); was your close an objection @hugomrdias ?

@hugomrdias
Copy link
Copy Markdown
Member

hugomrdias commented Dec 3, 2025

No, we reopened afterwards because of this #440 (comment) i thought it was already enabled by default because of this

options.withCDN === true,
but it isn't.

Im good with merging but we probably should remove that options.withCDN === true,

@geomatrick
Copy link
Copy Markdown
Collaborator Author

We can update the wording. I agree it isn't the best.

@geomatrick
Copy link
Copy Markdown
Collaborator Author

Wording updated

@hugomrdias hugomrdias merged commit 69d76c2 into master Dec 4, 2025
3 checks passed
@hugomrdias hugomrdias deleted the docs-update/add-filbeam-to-setup branch December 4, 2025 14:35
@github-project-automation github-project-automation Bot moved this from ⌨️ In Progress to 🎉 Done in FOC Dec 4, 2025
lordshashank pushed a commit to lordshashank/synapse-sdk that referenced this pull request Mar 9, 2026
Co-authored-by: patrickwoodhead <patrick.woodhead@protocol.ai>
Co-authored-by: Rod Vagg <rod@vagg.org>
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.

4 participants