Skip to content

errors: Point docs publishing steps at ably/website - #359

Merged
lmars merged 1 commit into
mainfrom
update-docs-repo
Aug 14, 2026
Merged

errors: Point docs publishing steps at ably/website#359
lmars merged 1 commit into
mainfrom
update-docs-repo

Conversation

@lmars

@lmars lmars commented Aug 13, 2026

Copy link
Copy Markdown
Member

The docs site moved out of ably/docs (now archived) and into the apps/docs app in ably/website. The "Publishing to the docs site" sections in errors/README.md and errors/CLAUDE.md still described the old repo, so the steps no longer worked as written.

Several details changed alongside the move, so this updates the steps rather than just swapping the repo name — each verified against ably/website on GitHub:

Was (ably/docs) Now (ably/website)
repo root apps/docs app
submodule ably-common submodule apps/docs/ably-common (per the root .gitmodules)
yarn generate:errors pnpm generate:errors
src/pages/docs/platform/errors/codes/ apps/docs/src/pages/docs/platform/errors/codes/
GitHub Actions check-error-docs CircleCI docs-check-error-docs (.circleci/docs-config.yml)

The ably/docs#3496 worked-example link is kept — the repo is archived rather than deleted, so the PR still resolves — but it's now labelled as predating the move, so nobody follows it expecting the current layout.

Docs only; no code or registry entries touched.

🤖 Generated with Claude Code

The docs site moved out of ably/docs (now archived) and into the apps/docs
app in ably/website. Several details of the publishing flow changed with it,
so update the steps rather than just the repo name:

- the submodule is recorded at apps/docs/ably-common in the root .gitmodules
- the generator runs under pnpm, not yarn
- generated pages land in apps/docs/src/pages/docs/platform/errors/codes/
- the CI guard is the CircleCI job docs-check-error-docs

The ably/docs#3496 example link is kept — the repo is archived rather than
deleted, so it still resolves — but labelled as predating the move.

Co-Authored-By: Claude Opus 5 (1M context) <[email protected]>
@lmars
lmars requested a review from AndyTWF August 13, 2026 11:07
@lmars
lmars merged commit dbad855 into main Aug 14, 2026
2 checks passed
@lmars
lmars deleted the update-docs-repo branch August 14, 2026 19:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants