{"id":20770544,"url":"https://github.com/ably/docs","last_synced_at":"2025-08-22T03:31:41.177Z","repository":{"id":5999103,"uuid":"7221949","full_name":"ably/docs","owner":"ably","description":"Ably Realtime API documentation ","archived":false,"fork":false,"pushed_at":"2024-10-29T13:25:48.000Z","size":242447,"stargazers_count":20,"open_issues_count":117,"forks_count":41,"subscribers_count":29,"default_branch":"main","last_synced_at":"2024-10-29T16:04:36.670Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://ably.com/docs","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ably.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2012-12-18T10:59:49.000Z","updated_at":"2024-10-25T14:38:21.000Z","dependencies_parsed_at":"2023-10-13T07:21:20.075Z","dependency_job_id":"9866c2c7-b48b-48ae-85ce-62e75fe48452","html_url":"https://github.com/ably/docs","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ably%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ably%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ably%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ably%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ably","download_url":"https://codeload.github.com/ably/docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230554330,"owners_count":18244234,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-17T12:10:13.493Z","updated_at":"2025-08-22T03:31:41.171Z","avatar_url":"https://github.com/ably.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ably Docs\n\nThis repository is the source for content published to [https://ably.com/docs](https://ably.com/docs).\n\nThe source content is written in [Textile](https://github.com/textile/textile-spec) and the site is generated by [Gatsby](https://www.gatsbyjs.com/).\n\n## Run locally\n\nTo run the docs site locally, run `bin/dev` from the root directory. Alternatively, follow these steps:\n\n1. Install Node 20 and Yarn 1.22\n\n2. Clone this repository and make it your working directory.\n\n3. Run `yarn install` to install all dependencies.\n\n4. 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.\n\n5. Run `yarn run develop` and visit `localhost:8000` to view the site.\n\n## Contribute\n\nView the [contribution guide](CONTRIBUTING.md) for information on how to write content and contribute to Ably docs.\n\n## Support\n\nIf you have any questions or suggestions, please [raise an issue](https://github.com/ably/docs/issues).\n\n## Website Proxy\n\nThe Website app forwards requests to `/docs` to the `docs.ably.com` site.\n\nAsset prefixing is applied only during the app build process and is not available in the dev version.\n\nTo ensure proper setup in your local:\n\n1. Set the `ASSET_PREFIX=http://localhost:9000` variable in your environment.\n2. Add `DOCS_BASE_URL=http://localhost:9000` to your `.env` file in the root of the Website app.\n3. Ensure that `.env.production` exists in the app root for the Yarn build to function correctly.\n4. You should be able to view the content and toggle between signed in and signed-out states.\n\n## Review apps\n\nCreate a review app by adding the `review-app` label to your PR.\n\n### Access and authentication\n\nReview apps can only be generated by members of the Ably GitHub organisation and are protected by basic authentication.\n\n### Cleanup\n\nReview apps are automatically cleaned up when:\n\n- A PR is closed, or;\n- The `review-app` label is removed.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fably%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fably%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fably%2Fdocs/lists"}