Ably is a hugely scalable, superfast and secure hosted realtime messaging service for web-enabled devices.
This Git repository contains most of the Ably API documentation that resides at https://ably.io/documentation in Textile format. Nanoc is used to build the static site from the source branch.
The Ably documentation was intentionally created as a public repository using a simple text based markup language so that:
- It can be maintained by Ably staff and developers.
- 3rd parties can fork the repository, and submit pull requests to improve the documentation. We welcome the community's suggestions and input.
- This documentation is later merged upstream to the Ably primary website documentation with each website releas.
The static site generated from this documentation repository is hosted at http://docs.ably.io. We frequently publish updates from this repository so is typically more up to date than the official Ably API documentation.
The official complete Ably documentation that incoporates all the documentation in this repository can be found at https://ably.io/documentation
- Fork the repository at https://github.com/ably/docs
- Clone a local version of your forked repo
git clone https://github.com/[you]/docsandcdinto it - Checkout the source branch:
git checkout source - Create your feature or fix branch and check it out:
git checkout -b [your-branch] bundle installto install the necessary gemsnanocto generate the site for the first timenanoc view -p 4000to start up a web server at http://localhost:4000bundle exec guardto watch for changes and rebuild the site automatically- Make your changes and they should be visible within seconds in the browser following a refresh. If the changes are not visible, check your console where
guardis running for errors. - Commit your changes, push your branch and send us a pull request
If you have any questions or suggestions, please get in touch with us at Ably