Skip to content

Runtime support policy is clearly communicated #697

@BigLep

Description

@BigLep

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

  1. We had confusion even within the FOC WG about whether browsers are supported: https://filecoinproject.slack.com/archives/C08TVNKJV7C/p1774453575105269
  2. 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"
  1. At a minimum, this information belongs in docs.filecoin.cloud since the Synapse README drives traffic there.
  2. 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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    🐱 Todo

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions