-
Notifications
You must be signed in to change notification settings - Fork 25
docs(getting-started): add Python and Go SDK links #594
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
rvagg
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for putting this together @anjor. It's good to see SDK work happening in other languages.
My concern is with the framing: listing these alongside the official TypeScript SDK as "SDKs by Language" suggests they're maintained or endorsed by the team, and we're not in a position to make that claim since we haven't been involved in their development or reviewed them for compatibility with the current contracts or our product goals for FOC. The protocol surface is still moving and we'd rather not create expectations we can't back up.
I'd be happy to have community projects linked from the docs, but with framing that makes the distinction clear; something like a "Community" callout rather than a peer listing. I'd also prefer to keep the Getting Started page focused on the official SDK and leave Python/Go quickstarts to those projects' own docs.
@nijoe1 could you work with Anjor on finding the right way to present this?
Address review feedback: - Move SDK links to 'Community SDKs' callout with disclaimer - Remove Python quickstart from Getting Started (link to pynapse README) - Keep official TS SDK as the primary focus
|
I see your point and have amended the PR accordingly. However I would like to flag that these were official docs for foc, and not just the ts synapse SDK (deployed to filecoin.cloud). Surely the interactions with foc should be independent of the sdk used? In any case, due to the fast moving nature of the protocol I do agree with the explicit callout that go-synapse and pynapse are community maintained (maybe go-synapse less so than pynapse since it's funded by FF?), and have changed the PR accordingly. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Adds documentation pointers to community-maintained Synapse SDKs so developers can discover non-TypeScript language options from key entry points in the docs.
Changes:
- Added a “Community SDKs” admonition in Getting Started linking to Python and Go SDK repositories.
- Added the same “Community SDKs” admonition in the Synapse SDK developer guide.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/src/content/docs/getting-started/index.mdx | Adds a Community SDKs note with Python/Go links near installation instructions. |
| docs/src/content/docs/developer-guides/synapse.md | Adds the same Community SDKs note near the top of the Synapse SDK overview page. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
I was thinking that a new page inside |
|
I am fine with whatever. |
|
Yes I think this is the best solution here! @anjor |
|
Done! I've created a dedicated Changes:
The new page is also structured to accommodate future community projects (tools, example apps, etc.) in one centralized place. |
nijoe1
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
|
@rvagg cool to merge? You will need to remove your request for changes. |
rvagg
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
cool, thanks @anjor
Added community supported language sdks