Skip to content
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

Add intro blurb to the Go static site generated #558

Closed
sacOO7 opened this issue Nov 17, 2022 · 1 comment · Fixed by #556
Closed

Add intro blurb to the Go static site generated #558

sacOO7 opened this issue Nov 17, 2022 · 1 comment · Fixed by #556
Assignees

Comments

@sacOO7
Copy link
Collaborator

sacOO7 commented Nov 17, 2022

To standardise all SDK docs and help customers understand the difference between auto-generated docs and other API reference docs available on the main site, we’ve worked on a generic piece of text to include on the intro page of all SDKs. As part of this ticket, the following text needs to be added to the intro page of the Go SDK.

# Ably Go Client Library SDK API Reference

The Go Client Library SDK supports a realtime and a REST interface. The Go API references are generated from the [Ably Go Client Library SDK source code](https://github.com/ably/ably-go/) using [godoc](https://pkg.go.dev/golang.org/x/tools/cmd/godoc) and structured by classes.

The realtime interface enables a client to maintain a persistent connection to Ably and publish, subscribe and be present on channels. The REST interface is stateless and typically implemented server-side. It is used to make requests such as retrieving statistics, token authentication and publishing to a channel.

View the [Ably docs](https://ably.com/docs/) for conceptual information on using Ably, and for API references featuring all languages. The combined [API references](https://ably.com/docs/api/) are organized by features and split between the [realtime](https://ably.com/docs/api/realtime-sdk) and [REST](https://ably.com/docs/api/rest-sdk) interfaces.
@sync-by-unito
Copy link

sync-by-unito bot commented Nov 17, 2022

➤ Automation for Jira commented:

The link to the corresponding Jira issue is https://ably.atlassian.net/browse/SDK-2947

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging a pull request may close this issue.

1 participant