[DX-444] Update account and app docs by m-hulbert · Pull Request #3302 · ably/docs

m-hulbert · 2026-03-26T18:15:23Z

Description

This PR does the following:

Updates the account settings docs with any relevant changes since the new dashboard release.
Removes the pages dedicated to app-specific pages. These were repeating information on how to interact with the UI which aren't relevant to explain.
Redirects any changed/deleted pages to relevant paths, e.g. API keys in the dashboard to the authentication section covering API keys.

Supersedes #3061.

Checklist

Commits have been rebased.
Linting has been run against the changed file(s).
The PR adheres to the writing style guide and contribution guide.

coderabbitai · 2026-03-26T18:15:32Z

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: dff177a2-67cb-47e4-9820-d67912d1280b

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch dx-444-dashboard-docs-updates

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Add redirect from /docs/account/app to Account overview. Remove App management nav section and associated images. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Add redirects to Account overview. Update TLS/settings links in Encryption and Error codes pages. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Add redirects to Auth page. Update API key links in Error codes page. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Add redirects to Debugging page. Rename Dev console section to Web client. Update console link in Metadata subscribe page. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Add redirects to Push notifications page. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Add redirect to Integrations Queues page. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Remove page and associated screenshot images. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Rename users.mdx to team.mdx with updated content and redirects. Update all references across pricing pages and nav. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Rewrite content to reflect new dashboard layout and navigation. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Update navigation steps and links for new dashboard layout. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Update screenshots and navigation instructions for new dashboard. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Add anchor IDs to headings and clean up formatting. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Update navigation steps, formatting, and link references. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Update navigation steps and links for new dashboard layout. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Add reference to CLI section in dashboard and new screenshot. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

matt423 · 2026-04-20T11:28:03Z


 Use organizations to manage multiple Ably accounts by centralizing user access and roles under a single organizational structure. Organizations streamline user provisioning through [Single Sign-On (SSO)](/docs/platform/account/sso) configuration and utilize SCIM System for Cross-domain Identity Management for group-based access control.

+Access your [organization settings](https://ably.com/accounts/any/organization) to manage your organization configuration and user access.


This URL 404s. Org routes are rooted at /organizations/:id/, and unlike accounts they don't support the any slug shortcut — so /accounts/any/organization has no matching GET route.

Suggest dropping the link, or rewording so readers navigate to organization settings from the account dropdown instead.

Claude

matt423 · 2026-04-20T11:31:28Z

  - /docs/general/versions/v0.8/queues
  - /docs/general/queues
  - /docs/integrations/queues
+  - /docs/account/app/queues


Only the legacy /docs/account/app/queues is redirected here. The canonical /docs/platform/account/app/queues URL (which was in the sidebar nav for years, so likely bookmarked and indexed) isn't redirected anywhere and will 404 after this merges. Worth adding it alongside.

Same gap exists for the deleted stats page: neither /docs/platform/account/app/stats nor /docs/account/app/stats is redirected anywhere in this PR. Suggest adding both to platform/account/index.mdx's redirect_from (consistent with where app/settings landed), or pointing them at /docs/metadata-stats/stats if that's a better conceptual home.

Claude

m-hulbert self-assigned this Mar 26, 2026

m-hulbert marked this pull request as draft March 27, 2026 17:11

matt423 mentioned this pull request Apr 17, 2026

docs(account): update settings pages for new dashboard UX (DX-1074) #3344

Open

3 tasks

m-hulbert and others added 15 commits April 19, 2026 13:08

Remove App management overview page for new dashboard release

67ecadf

Add redirect from /docs/account/app to Account overview. Remove App management nav section and associated images. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Remove App Settings page for new dashboard release

80edb74

Add redirects to Account overview. Update TLS/settings links in Encryption and Error codes pages. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Remove API keys dashboard page for new dashboard release

73a4f5b

Add redirects to Auth page. Update API key links in Error codes page. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Remove Dev console dashboard page for new dashboard release

7e9bcc6

Add redirects to Debugging page. Rename Dev console section to Web client. Update console link in Metadata subscribe page. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Remove Notifications dashboard page for new dashboard release

c773821

Add redirects to Push notifications page. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Remove Queues dashboard page for new dashboard release

830d85a

Add redirect to Integrations Queues page. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Remove Stats dashboard page for new dashboard release

821ea09

Remove page and associated screenshot images. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Rename User management to Team for new dashboard release

7e65e04

Rename users.mdx to team.mdx with updated content and redirects. Update all references across pricing pages and nav. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Update Account overview page for new dashboard release

2a1a8de

Rewrite content to reflect new dashboard layout and navigation. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Update 2FA page for new dashboard release

431b0b0

Update navigation steps and links for new dashboard layout. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Update Control API page for new dashboard release

5a8b16b

Update screenshots and navigation instructions for new dashboard. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Update Enterprise customization page for new dashboard release

ed3eaca

Add anchor IDs to headings and clean up formatting. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Update Organizations page for new dashboard release

3fdc1db

Update navigation steps, formatting, and link references. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Update SSO page for new dashboard release

0707a06

Update navigation steps and links for new dashboard layout. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Update CLI page for new dashboard release

2a8bb54

Add reference to CLI section in dashboard and new screenshot. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

m-hulbert force-pushed the dx-444-dashboard-docs-updates branch from 185df8f to 2a8bb54 Compare April 19, 2026 12:18

m-hulbert marked this pull request as ready for review April 19, 2026 12:18

m-hulbert requested a review from matt423 April 20, 2026 07:48

matt423 added the review-app Create a Heroku review app label Apr 20, 2026

ably-ci deployed to ably-docs-dx-444-dashbo-zwp2k6 April 20, 2026 08:50 View deployment

matt423 reviewed Apr 20, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DX-444] Update account and app docs#3302

[DX-444] Update account and app docs#3302
m-hulbert wants to merge 15 commits intomainfrom
dx-444-dashboard-docs-updates

m-hulbert commented Mar 26, 2026 •

edited

Loading

Uh oh!

coderabbitai bot commented Mar 26, 2026 •

edited

Loading

Review skipped

Uh oh!

matt423 Apr 20, 2026

Uh oh!

matt423 Apr 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants


		Use organizations to manage multiple Ably accounts by centralizing user access and roles under a single organizational structure. Organizations streamline user provisioning through [Single Sign-On (SSO)](/docs/platform/account/sso) configuration and utilize SCIM System for Cross-domain Identity Management for group-based access control.

		Access your [organization settings](https://ably.com/accounts/any/organization) to manage your organization configuration and user access.

Conversation

m-hulbert commented Mar 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

coderabbitai bot commented Mar 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Uh oh!

matt423 Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

matt423 Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

m-hulbert commented Mar 26, 2026 •

edited

Loading

coderabbitai bot commented Mar 26, 2026 •

edited

Loading