-
Notifications
You must be signed in to change notification settings - Fork 27
Runtime support policy is clearly communicated #697
Copy link
Copy link
Open
Milestone
Description
Done Criteria
A new user can quickly determine what JS runtimes Synapse supports.
Why Important
Helps user determine if Synapse is appropriate for their usecase. We want to particularly avoid a user coming to a conclusion that Synapse doesn't support something that it actually does (i.e., a user thinking Synapse doesn't work in browsers when it actually does).
User/Customer
New propspective users who are determining if their application/setup can take advantage of Syanpse
Notes
- We had confusion even within the FOC WG about whether browsers are supported: https://filecoinproject.slack.com/archives/C08TVNKJV7C/p1774453575105269
- I would like to see us make statements like:
- "We support the latest major versions of Node, Chrome, Safari, and Firefox"
- "Our CI runs tests against these runtimes in LINK_TO_CI"
- "If working with browsers, consider using synapse-react"
- At a minimum, this information belongs in docs.filecoin.cloud since the Synapse README drives traffic there.
- I think it also makes sense to add a "Runtime Support" section to the Synapse README, which in turn can just link to docs.filecoin.cloud section.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels
Type
Projects
Status
🐱 Todo