https://github.com/ably/docs
Ably Realtime API documentation
https://github.com/ably/docs
Last synced: 10 months ago
JSON representation
Ably Realtime API documentation
- Host: GitHub
- URL: https://github.com/ably/docs
- Owner: ably
- License: apache-2.0
- Created: 2012-12-18T10:59:49.000Z (over 13 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T13:25:48.000Z (over 1 year ago)
- Last Synced: 2024-10-29T16:04:36.670Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://ably.com/docs
- Size: 231 MB
- Stars: 20
- Watchers: 29
- Forks: 41
- Open Issues: 117
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Ably Docs
This repository is the source for content published to [https://ably.com/docs](https://ably.com/docs).
The source content is written in [Textile](https://github.com/textile/textile-spec) and the site is generated by [Gatsby](https://www.gatsbyjs.com/).
## Run locally
To run the docs site locally, run `bin/dev` from the root directory. Alternatively, follow these steps:
1. Install Node 20 and Yarn 1.22
2. Clone this repository and make it your working directory.
3. Run `yarn install` to install all dependencies.
4. If this is the first time running the site, run `yarn run develop:env-setup` to setup your environment variables. Visit `localhost:8000` to view the site.
5. Run `yarn run develop` and visit `localhost:8000` to view the site.
## Contribute
View the [contribution guide](CONTRIBUTING.md) for information on how to write content and contribute to Ably docs.
## Support
If you have any questions or suggestions, please [raise an issue](https://github.com/ably/docs/issues).
## Website Proxy
The Website app forwards requests to `/docs` to the `docs.ably.com` site.
Asset prefixing is applied only during the app build process and is not available in the dev version.
To ensure proper setup in your local:
1. Set the `ASSET_PREFIX=http://localhost:9000` variable in your environment.
2. Add `DOCS_BASE_URL=http://localhost:9000` to your `.env` file in the root of the Website app.
3. Ensure that `.env.production` exists in the app root for the Yarn build to function correctly.
4. You should be able to view the content and toggle between signed in and signed-out states.
## Review apps
Create a review app by adding the `review-app` label to your PR.
### Access and authentication
Review apps can only be generated by members of the Ably GitHub organisation and are protected by basic authentication.
### Cleanup
Review apps are automatically cleaned up when:
- A PR is closed, or;
- The `review-app` label is removed.