errors: Document publishing to the docs site - #354
Merged
Merged
Conversation
Registry edits are not live on ably.com/docs until pulled into the docs site, which vendors this directory as a git submodule. Record the downstream step — bump the ably-common submodule in ably/docs, run `yarn generate:errors`, commit the regenerated pages, open a docs PR — in README.md and CLAUDE.md so it isn't missed after a registry change. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
m-hulbert
approved these changes
Jul 27, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Records the downstream publish step for error-code changes in
errors/README.mdanderrors/CLAUDE.md.Edits to this registry are not live on ably.com/docs until they are pulled into the docs site, which vendors this directory as a git submodule. That step is easy to forget after a registry change merges, so it's now written down.
What's documented
After a registry change merges to
main, a follow-up PR againstably/docs:ably-commonsubmodule (usually tomain).yarn generate:errors.src/pages/docs/platform/errors/codes/pages alongside the bump.The
ably/docscheck-error-docsCI regenerates and diffs, so out-of-sync pages fail the build. ably/docs#3496 is linked as a worked example.README.md— full step-by-step under a new "Publishing to the docs site" section.CLAUDE.md— condensed version for agents, linking back to the README.Docs-only change; no code, registry entries, or
errors.jsontouched.🤖 Generated with Claude Code