Skip to content

Add standalone access tokens page for new dashboard UI#3291

Open
matt423 wants to merge 1 commit intomainfrom
dx-563-access-tokens
Open

Add standalone access tokens page for new dashboard UI#3291
matt423 wants to merge 1 commit intomainfrom
dx-563-access-tokens

Conversation

@matt423
Copy link
Member

@matt423 matt423 commented Mar 19, 2026

Summary

Note

To be merged when tokens website PR is deployed

  • Creates a new standalone Access tokens page at /docs/platform/account/access-tokens covering token creation, capabilities, revocation, and rate limits
  • Access tokens are used by both the Control API and CLI, so they no longer live inline in the Control API page
  • Slims down the Control API auth section to link to the new page
  • Adds a capability reference table mapping dashboard labels to Control API endpoints and CLI commands
  • Renames "My Access Tokens" to "Access tokens" throughout
  • Removes 3 outdated screenshots from the Control API page

Test plan

Review App

  • Verify /docs/platform/account/access-tokens renders correctly
  • Verify Control API page auth section links to new page
  • Verify capability table API reference links resolve correctly
  • Verify nav entry appears in sidebar under Account
  • Check CLI docs link to access tokens page works
  • Review on a review app with review-app label

Summary by CodeRabbit

  • New Features

    • Added comprehensive access token documentation covering creation steps, capability mapping, revocation behavior, and rate limits for Control API and CLI usage.
  • Documentation

    • Streamlined Control API documentation with links to dedicated access token guidance.
    • Updated CLI documentation with clearer access token setup instructions.
    • Added navigation entry for centralized access token documentation.

Access tokens are used by both the Control API and CLI, so they
now have their own page at /docs/platform/account/access-tokens
rather than being documented inline in the Control API page.

- Create access-tokens.mdx with creation flow, capability table
  (with Control API and CLI command mappings), revocation, and
  rate limits
- Slim down control-api.mdx auth section to link to new page
- Rename "My Access Tokens" to "Access tokens" throughout
- Remove outdated screenshots from Control API page
- Add access tokens nav entry in platform.ts
- Link CLI docs to new access tokens page
@coderabbitai
Copy link

coderabbitai bot commented Mar 19, 2026

Walkthrough

Documentation additions and updates consolidate access token guidance into a dedicated resource. A new navigation entry directs users to comprehensive access token documentation covering creation, capability mapping, revocation, and rate limits. Existing platform documentation updated to reference this new guide.

Changes

Cohort / File(s) Summary
Navigation Updates
src/data/nav/platform.ts
Added "Access tokens" navigation entry linking to /docs/platform/account/access-tokens.
New Documentation
src/pages/docs/platform/account/access-tokens.mdx
Comprehensive access token documentation covering creation workflow, capability mappings, revocation behavior, and rate limits for both Control API and Ably CLI.
Documentation Consolidation
src/pages/docs/platform/account/control-api.mdx, src/pages/docs/platform/account/index.mdx, src/pages/docs/platform/tools/cli.mdx
Updated references to link to new access tokens page; condensed inline token creation instructions; aligned rate limit descriptions across pages.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 A token's tale now clearly told,
In docs both bright and bold!
No secrets hidden, all in sight—
Access management done right!
The bunny hops through links so sweet,
Making guidance quite complete! 🥕

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main objective: adding a new standalone access tokens documentation page to support a new dashboard UI. It directly matches the primary change across all modified files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch dx-563-access-tokens
📝 Coding Plan
  • Generate coding plan for human review comments

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

@matt423 matt423 added the review-app Create a Heroku review app label Mar 19, 2026
@matt423
Copy link
Member Author

matt423 commented Mar 19, 2026

@coderabbitai review

@coderabbitai
Copy link

coderabbitai bot commented Mar 19, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@ably-ci ably-ci had a problem deploying to ably-docs-dx-563-access-xnjetk March 19, 2026 21:19 Failure
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
src/pages/docs/platform/account/control-api.mdx (1)

33-47: ⚠️ Potential issue | 🟡 Minor

Update the downstream token reference to prevent a broken in-page link.

After this auth-content move, the page no longer defines #creating-access-token, but Line 814 still links to it. That reference should point to the new access token page anchor instead.

Suggested fix (outside this selected range)
-First, you need to [obtain a Control API token](`#creating-access-token`) to authenticate any requests you send to the Control API.
+First, you need to [obtain a Control API token](/docs/platform/account/access-tokens#create) to authenticate any requests you send to the Control API.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@src/pages/docs/platform/account/control-api.mdx` around lines 33 - 47, The
page still contains links pointing to the removed in-page fragment
"#creating-access-token"; find occurrences of that fragment (the broken link
referenced in the comment) and update them to point to the correct access-token
page anchor instead (replace "#creating-access-token" with the new anchor on the
access tokens page, e.g. "/docs/platform/account/access-tokens" or
"/docs/platform/account/access-tokens#<new-anchor>"). Ensure you update the link
target(s) in this file (control-api.mdx) so they reference the external
access-tokens page/anchor rather than the removed in-page id.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@src/pages/docs/platform/account/index.mdx`:
- Line 65: The "Access tokens" section heading lacks the required HTML anchor;
update the heading line for "Access tokens" to include a standard HTML anchor
tag (e.g., add <a id="access-tokens"/> after the heading text) so it follows the
docs convention of "Use standard markdown headings with HTML anchor tags for
section headers" and ensure the anchor id is unique and kebab-case.

---

Outside diff comments:
In `@src/pages/docs/platform/account/control-api.mdx`:
- Around line 33-47: The page still contains links pointing to the removed
in-page fragment "#creating-access-token"; find occurrences of that fragment
(the broken link referenced in the comment) and update them to point to the
correct access-token page anchor instead (replace "#creating-access-token" with
the new anchor on the access tokens page, e.g.
"/docs/platform/account/access-tokens" or
"/docs/platform/account/access-tokens#<new-anchor>"). Ensure you update the link
target(s) in this file (control-api.mdx) so they reference the external
access-tokens page/anchor rather than the removed in-page id.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: d1ab5fca-1f91-435d-b4dd-3da3d0afefa7

📥 Commits

Reviewing files that changed from the base of the PR and between 92fe224 and dde3439.

📒 Files selected for processing (5)
  • src/data/nav/platform.ts
  • src/pages/docs/platform/account/access-tokens.mdx
  • src/pages/docs/platform/account/control-api.mdx
  • src/pages/docs/platform/account/index.mdx
  • src/pages/docs/platform/tools/cli.mdx

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.

2 participants