Skip to content

Commit

Permalink
Merge pull request #1 from ably/master
Browse files Browse the repository at this point in the history
update to ably-master
  • Loading branch information
samuelayo authored Jun 4, 2019
2 parents f21551c + a812777 commit fe58d6c
Show file tree
Hide file tree
Showing 16 changed files with 4,783 additions and 95 deletions.
2 changes: 1 addition & 1 deletion textile/comet.textile
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jump_to:

h2(#overview). Overview

The Ably realtime service supports client connections over multiple transports. The Comet transport is a fallback transport for environments that are unable to support WebSockets (eg older browser versions) or for environments for which intervening proxies do not support WebSockets.
The Ably realtime service supports client connections over multiple transports. The Comet transport is a fallback transport for environments that are unable to support "WebSockets":/concepts/websockets (eg older browser versions) or for environments for which intervening proxies do not support "WebSockets":/concepts/websockets.

In the Comet protocol, all request and response bodies contain an array of one or more protocol messages. In the binary protocol this is a standard binary "MessagePack encoding":http://msgpack.org/. In the text (JSON) protocol request and response bodies are simply JSON-encoded arrays containing the Protocol Message content, again either in binary (MessagePack) or text (JSON) encoding.

Expand Down
14 changes: 7 additions & 7 deletions textile/documentation-formatting-guide.textile
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ index: 60
jump_to:
Help with:
- Overview and Textile#title
- Meta data
- Metadata
- Markup fundamentals
- Code blocks
- Language specific content
Expand All @@ -23,9 +23,9 @@ Please see this "documentation repository's README":http://github.com/ably/READM

Detailed below are specific Ably layout techniques that you should be aware of when writing documentation. All standard Textile markup is supported in addition to what is documented below.

h2(#meta-data). Meta data
h2(#meta-data). Metadata

At the top of each textile page, the following meta data can be included as follows:
At the top of each textile page, the following metadata can be included as follows:

bc[yaml]. ---
title: "Enter a title that will appear in the navigation and HTML page title"
Expand Down Expand Up @@ -70,10 +70,10 @@ h3. Documentation links

Absolute reference links such as @"Google":http://www.google.com@ can be used as normal.

All links to other documentation pages must follow the format @"REST Channels":/rest/channels-messages"@ and must resolve to a relative path for this repository. When imported into the main Ably website, the links will be automatically modified to link to the correct page in the Ably webite documentation.
All links to other documentation pages must follow the format @"REST Channels":/rest/channels"@ and must resolve to a relative path for this repository. When imported into the main Ably website, the links will be automatically modified to link to the correct page in the Ably webite documentation.
Anchor links can be used as follows @"REST spec stats":/rest/statistics#stats@.

Links can also contain mono-spaced code references within the link using the format <notextile><code>"@mono-spaced-link-text@":/rest/channels-messages</code></notextile>, which would appear as "@mono-spaced-link-text@":/rest/channels-messages
Links can also contain mono-spaced code references within the link using the format <notextile><code>"@mono-spaced-link-text@":/rest/channels</code></notextile>, which would appear as "@mono-spaced-link-text@":/rest/channels

h2(#code-blocks). Code blocks

Expand Down Expand Up @@ -437,7 +437,7 @@ Inline Table of Contents are typically used at the start of a new section (such
bc[yaml]. inline-toc.
Channel Object Reference:
- Example:
- Meta data // the anchor link #meta-data will be used automatically
- Metadata // the anchor link #meta-data will be used automatically
- Manually configured#code-blocks
- Language Specific Content#language-specific-content
- Conditional navigation shown when anchor is visible#conditional-nav
Expand All @@ -447,7 +447,7 @@ The above code produces the following element:
inline-toc.
Channel Object Reference:
- Methods:
- Meta data
- Metadata
- Manually configured#code-blocks
- Language Specific Content#language-specific-content
- Conditional navigation shown when anchor is visible (not Ruby)#conditional-nav
Expand Down
2 changes: 1 addition & 1 deletion textile/feature-prioritisation.textile
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The complete feature specification for REST libraries is available at "specifica
h2. Realtime client library feature prioritisation

* REST client library - assumes that "complete feature specification for REST libraries":https://github.com/ably/ably-ruby-rest/blob/master/SPEC.md has been implemented and is available to this new realtime client library.
* Simple realtime connection over WebSockets with JSON & MessagePack support - see "#initialization, #connect and #close within connection spec":https://github.com/ably/ably-ruby/blob/master/SPEC.md#ablyrealtimeconnection and "ProtocolMessage object spec":https://github.com/ably/ably-ruby/blob/master/SPEC.md#ablymodelsprotocolmessage
* Simple realtime connection over "WebSockets":/concepts/websockets with JSON & MessagePack support - see "#initialization, #connect and #close within connection spec":https://github.com/ably/ably-ruby/blob/master/SPEC.md#ablyrealtimeconnection and "ProtocolMessage object spec":https://github.com/ably/ably-ruby/blob/master/SPEC.md#ablymodelsprotocolmessage
* Attach, detach, publish and subscribe for channels - see "Channel spec":https://github.com/ably/ably-ruby/blob/master/SPEC.md#ablyrealtimechannel and "channels object spec":https://github.com/ably/ably-ruby/blob/master/SPEC.md#ablyrealtimechannels
* Message encoding and encryption on realtime channels - see "Message spec":https://github.com/ably/ably-ruby/blob/master/SPEC.md#ablyrealtimechannel-message
* Presence subscriptions, enter, update and leave - see "#enter, #update, #leave, #subscribe and #unsubcribe of Presence spec":https://github.com/ably/ably-ruby/blob/master/SPEC.md#ablyrealtimepresence
Expand Down
Loading

0 comments on commit fe58d6c

Please sign in to comment.