Skip to content

Commit

Permalink
Remove docs/class-definitions.md
Browse files Browse the repository at this point in the history
All of the valuable content from document was copied to TSDoc comments
in 307e476, and I don’t want us to need to maintain two copies of this
content.

So, replace links to this document with links to the TypeDoc-generated
documentation on sdk.ably.com (it’s not ideal that these links always
link to the documentation for the `main` branch, regardless of which
version of the codebase the user is browsing, but we can think about how
to fix that later) and delete it.
  • Loading branch information
lawrence-forooghian committed Oct 17, 2023
1 parent 9d726d8 commit d0365b2
Show file tree
Hide file tree
Showing 11 changed files with 64 additions and 748 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Changes to the app state made by users not only need to be synced with your back
The Spaces SDK is currently under development. If you are interested in being an early adopter and providing feedback then you can [sign up](https://go.ably.com/spaces-early-access) for early access and are welcome to [provide us with feedback](https://go.ably.com/spaces-feedback).

The next section gives you an overview of how to use the SDK. Alternatively, you can jump to:
* [Class definitions](/docs/class-definitions.md)
* [TypeDoc documentation](https://sdk.ably.com/builds/ably/spaces/main/typedoc/index.html)
* [Usage instructions](/docs/usage.md)
* [Channel behaviors](/docs/channel-behaviors.md)

Expand Down
4 changes: 2 additions & 2 deletions docs/channel-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The below channels are used by the Spaces library internally.

### Space channel

Each `Space` (as defined by the [`Space` class](/docs/class-definitions.md#space)) creates its own [Ably Channel](https://ably.com/docs/channels).
Each `Space` (as defined by the [`Space` class](https://sdk.ably.com/builds/ably/spaces/main/typedoc/classes/Space.html)) creates its own [Ably Channel](https://ably.com/docs/channels).

The channel name is defined by the `name` of the Space and takes the form: `${name}-space`. The full name of a `channel` belonging to a `Space` called 'slides' would therefore be `slides-space`.

Expand All @@ -18,4 +18,4 @@ The channel name is defined by the name of the Space with the `::$cursors` suffi

#### Events published

1. `cursorUpdate` - a batch of cursor updates passed to [`set`](/docs/class-definitions.md#set).
1. `cursorUpdate` - a batch of cursor updates passed to [`set`](https://sdk.ably.com/builds/ably/spaces/main/typedoc/classes/Cursors.html#set).
Loading

0 comments on commit d0365b2

Please sign in to comment.