Skip to content

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

Open
m-hulbert wants to merge 14 commits into
mainfrom
dx-444-dashboard-docs-updates
Open

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

Conversation

@m-hulbert
Copy link
Copy Markdown
Contributor

@m-hulbert m-hulbert commented Mar 26, 2026

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

@m-hulbert m-hulbert self-assigned this Mar 26, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 26, 2026

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: f7323a97-c4a8-49a3-b2c5-5277ee881726

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

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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.

@m-hulbert m-hulbert marked this pull request as draft March 27, 2026 17:11
@m-hulbert m-hulbert force-pushed the dx-444-dashboard-docs-updates branch from 185df8f to 2a8bb54 Compare April 19, 2026 12:18
@m-hulbert m-hulbert marked this pull request as ready for review April 19, 2026 12:18
@m-hulbert m-hulbert requested a review from matt423 April 20, 2026 07:48
@matt423 matt423 added the review-app Create a Heroku review app label Apr 20, 2026
@ably-ci ably-ci temporarily deployed to ably-docs-dx-444-dashbo-zwp2k6 April 20, 2026 08:50 Inactive
Comment thread src/pages/docs/platform/account/organizations.mdx Outdated
Comment thread src/pages/docs/platform/integrations/queues.mdx
@m-hulbert m-hulbert force-pushed the dx-444-dashboard-docs-updates branch from 2a8bb54 to 0572162 Compare May 12, 2026 08:53
@m-hulbert m-hulbert requested a review from matt423 May 12, 2026 09:10
@matt423 matt423 added review-app Create a Heroku review app and removed review-app Create a Heroku review app labels May 12, 2026
@ably-ci ably-ci temporarily deployed to ably-docs-dx-444-dashbo-3ks0iv May 12, 2026 09:35 Inactive
Comment thread src/pages/docs/platform/account/2fa.mdx Outdated
@matt423
Copy link
Copy Markdown
Member

matt423 commented May 13, 2026

Two newly added images don't appear to be referenced anywhere in the PR's state — no MDX embed, no main usage, no auto-pickup from data/ or Gatsby:

  • src/images/content/screenshots/dash/cli.png — the "Update CLI page for new dashboard release" commit only contains this binary; the matching cli.mdx text change that would have embedded it appears to have been dropped during rebase.
  • src/images/content/screenshots/dash/access-token-set.png — no references found anywhere.

Either restore the doc text that referenced them, or drop the images from the PR.

  • Claude

Comment thread src/images/content/screenshots/dash/cli.png Outdated
Copy link
Copy Markdown
Member

@matt423 matt423 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I pushed fixes for my comments, so let's :shipit:

m-hulbert and others added 9 commits May 13, 2026 17:16
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>
m-hulbert and others added 5 commits May 13, 2026 17:16
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>
@m-hulbert m-hulbert force-pushed the dx-444-dashboard-docs-updates branch from 5144f45 to 3478342 Compare May 13, 2026 16:19
@ably-ci ably-ci requested a deployment to ably-docs-dx-444-dashbo-3ks0iv May 13, 2026 16:19 Pending
@m-hulbert m-hulbert enabled auto-merge May 13, 2026 16:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

review-app Create a Heroku review app

Development

Successfully merging this pull request may close these issues.

3 participants