From b9981e8d17a98661916384f31bd3a1756835a0e6 Mon Sep 17 00:00:00 2001 From: Andy Ford Date: Mon, 10 Aug 2026 15:41:07 +0100 Subject: [PATCH] docs: mark repo as deprecated in favour of the monorepo Content and tooling for ably.com/docs have moved to ably/website; this repo is no longer where changes should be made. Co-Authored-By: Claude Sonnet 5 --- README.md | 55 ++----------------------------------------------------- 1 file changed, 2 insertions(+), 53 deletions(-) diff --git a/README.md b/README.md index 7baa20d81b..c1873b45c4 100644 --- a/README.md +++ b/README.md @@ -1,55 +1,4 @@ # 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 [GFM (GitHub-flavoured Markdown](https://github.github.com/gfm/) 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. +> [!IMPORTANT] +> This repository is deprecated. The source for [https://ably.com/docs](https://ably.com/docs) has moved to the [monorepo](https://github.com/ably/website). Please make any further changes there.