WEB-3914- Pass logOut and AccountName from SessionState to the @ably-ui v15.6.0 Header component

[aralovelace]

Description

WEB-3914 - updated the @ably-ui to 15.6.0 which includes an updated Header component including a dropdown and logout link when sessionState.SignedIn is true.

Checklist

Also includes updates to the documentation and codebase to improve local development setup and dependency management.

Documentation Improvements:

• Updated the .env.example file to include instructions for setting the ASSET_PREFIX when building locally with Yarn.
• Revised the README.md to correct the numbering of setup steps and added a new section on the website proxy configuration. [1] [2]

Dependency Management:

• Updated the @ably/ui dependency version in package.json from 15.4.1 to 15.6.0.

Code Enhancements:

• Added default values for logOut and accountName in the Header component to ensure proper initialization.

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

Summary by CodeRabbit

• Documentation
  • Revised local setup instructions with updated step numbering and a new proxy configuration section.
• Chores
  • Updated configuration settings and upgraded key dependencies.
• New Features
  • Enhanced the header by ensuring consistent defaults for logout and account display options.

[aralovelace]

@jamiehenson @kennethkalmer i tried to test the updated Header with logout - https://ably-docs-web-3914-head-mgssbz.herokuapp.com/docs but seems https://ably-dev.com/api/me returns error any idea is this only happened at preview apps?

[coderabbitai]

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.

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

Walkthrough

This pull request updates several files. The .env.example file now includes a new environment variable ASSET_PREFIX and fixes a newline for INKEEP_CHAT_ORGANIZATION_ID. In the README.md, the steps in the "Run locally" section are renumbered, and a new "Website Proxy" section is added with local development instructions. The package.json file upgrades the @ably/ui dependency from version "15.4.1" to "15.6.0". Additionally, the Header component in the frontend now initializes logOut and accountName properties in its session state.

Changes

File(s)	Change Summary
.env.example	Added ASSET_PREFIX with an inline comment; ensured INKEEP_CHAT_ORGANIZATION_ID ends with a newline.
README.md	Reordered "Run locally" steps (decremented numbering); added a new "Website Proxy" section detailing request forwarding and local setup instructions.
package.json	Upgraded @ably/ui dependency from "15.4.1" to "15.6.0".
src/components/Layout/Header.tsx	Introduced logOut (with default token and href) and accountName properties in the sessionState object using default fallbacks.

Possibly related PRs

• [EDU-1816] - Add NPM Workspaces to examples #2419: Involves environment variable updates in .env.example, providing context similar to the current changes.

Suggested reviewers

• jamiehenson
• kennethkalmer

Poem

I'm a bouncing bunny in a code-filled glen,
Hopping through changes with a cheerful yen.
New variables and proxies make my whiskers twitch,
Dep upgrades and defaults add an extra pitch.
I celebrate each line with a joyful leap—
Coding carrots, crunchy bytes, and dreams to keep!
🐇💻

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[aralovelace]

@coderabbitai review

[coderabbitai]

🧩 Analysis chain

I'll check the contents of the key files mentioned in the PR objectives:

Let me look at the specific changes to the Header component implementation:

Now let me look at the component files related to the Header or SessionState:

Let me try a different approach:

Let me look for the code related to SessionState:

Let me focus on looking at the actual diffs for this PR:

Let me check more specifically for changes in JS/TS/JSX/TSX files:

Let me check components directories to find the Header implementation:

Let me search for files that have been modified and contain "Header":

Let me check for any Layout files that might use the Header:

Let me try to find components that import from @ably/ui:

Let me look for component files related to the Header:

Let me check the content of these layout files:

Now I see the Header component is in Layout.jsx. Let's look at the changes specifically to this file:

Let me also check if there's a SessionState file:

Let me check where SessionState is defined or used:

Let me also check for any changes to auth or session-related files:

Given the PR objective to "Pass logOut and AccountName from SessionState to the @ably-ui v15.6.0 Header component", let me search for those specific props:

Now I have a better understanding of the changes. Let me also check for any issues mentioned in the comment about an error with the API endpoint:

Let me check if there are any files related to API configuration:

Based on the changes I've found, let me now provide a comprehensive review for the PR. The main changes include:

1. Updated the @ably/ui dependency to version 15.6.0
2. Updated the Header component in Layout.jsx to pass sessionState.logOut and sessionState.accountName to the Header component
3. Documentation improvements in README.md and .env.example

I'll now provide my final review that addresses the changes and also addresses the issue mentioned in the previous comment about the API error.

@aralovelace I have reviewed the changes in this PR which updates the @ably/ui to version 15.6.0 and passes the necessary sessionState properties to the Header component.

The key changes look good:

1. Updated @ably/ui package: Successfully updated from 15.4.1 to 15.6.0 in package.json
2. Updated Header implementation: Correctly passing logOut and accountName from sessionState to the Header component in Layout.jsx
3. Documentation improvements: Updated README.md with corrected numbering and added section on website proxy configuration
4. Environment configuration: Updated .env.example with instructions for ASSET_PREFIX

Regarding the issue you mentioned about the API error with https://ably-dev.com/api/me in the preview environment, this is likely related to the authentication setup in the preview environment. Since the updated Header component now expects authentication data to display the logout functionality, the error from the API endpoint would prevent this feature from working correctly in the preview deployment.

I'd recommend checking:

1. If the preview environment has proper authentication configuration
2. Whether there are CORS issues specific to the preview environment
3. If there's any difference in how the API endpoints are accessed between local development and preview environments

The code changes themselves look correct - the issue appears to be with the environment configuration rather than the implementation.

---

🏁 Script executed:

#!/bin/bash
# List the files changed in this PR
git diff --name-only HEAD~1 HEAD

Length of output: 221

---

🏁 Script executed:

#!/bin/bash
# Check .env.example
cat .env.example

# Check README.md changes
git diff HEAD~1 HEAD -- README.md

# Check package.json update
git diff HEAD~1 HEAD -- package.json

# Find the Header component file
fd "Header" --type f --exclude "node_modules" --exclude ".git"

Length of output: 761

---

🏁 Script executed:

#!/bin/bash
# Check the Header component implementation files 
fd -e jsx -e tsx "Header\.(jsx|tsx)$" --type f --exclude "node_modules" --exclude ".git"

# Find other potential Header component files
fd "header" --type f --exclude "node_modules" --exclude ".git" | grep -i "header" | grep -v "README"

Length of output: 644

---

🏁 Script executed:

#!/bin/bash
# Check the content of likely Header component files
find . -name "*header*" -o -name "*Header*" | grep -v "node_modules" | grep -v ".git" | grep -E "\.(js|jsx|ts|tsx)$" | xargs cat 2>/dev/null || echo "No files found"

Length of output: 7878

---

🏁 Script executed:

#!/bin/bash
# Find all files that might contain the Header component
fd -e jsx -e tsx -e js -e ts . --exclude "node_modules" --exclude ".git" | xargs grep -l "Header" | head -5

# Check the top files that mention Header
fd -e jsx -e tsx -e js -e ts . --exclude "node_modules" --exclude ".git" | xargs grep -l "Header" | head -1 | xargs cat

Length of output: 33628

---

🏁 Script executed:

#!/bin/bash
# Look for SessionState related files
fd -e jsx -e tsx -e js -e ts . --exclude "node_modules" --exclude ".git" | xargs grep -l "SessionState" | head -5

# Check the diff for any file that contains SessionState
git diff HEAD~1 HEAD -- $(fd -e jsx -e tsx -e js -e ts . --exclude "node_modules" --exclude ".git" | xargs grep -l "SessionState")

Length of output: 566

---

🏁 Script executed:

#!/bin/bash
# List all changed files
git diff HEAD~1 HEAD --name-only

# Look at the complete diff for the PR
git diff HEAD~1 HEAD

Length of output: 431

---

🏁 Script executed:

#!/bin/bash
# Look at the diff for JavaScript/TypeScript files
git diff HEAD~1 HEAD -- "*.js" "*.jsx" "*.ts" "*.tsx"

Length of output: 84

---

🏁 Script executed:

#!/bin/bash
# List directories that might contain components
find . -type d -name "components" -o -name "Components" | grep -v "node_modules" | grep -v ".git"

# Check the typical layout or structure files that might import Header
find . -type f -name "*layout*" -o -name "*Layout*" | grep -v "node_modules" | grep -v ".git" | grep -E "\.(js|jsx|ts|tsx)$" | xargs cat 2>/dev/null

Length of output: 19929

---

🏁 Script executed:

#!/bin/bash
# Find modified files containing "Header"
git diff --name-only HEAD~1 HEAD | xargs grep -l "Header" 2>/dev/null || echo "No matches found"

# Check those files in detail
git diff HEAD~1 HEAD -- $(git diff --name-only HEAD~1 HEAD | xargs grep -l "Header" 2>/dev/null) 2>/dev/null || echo "No matches found"

Length of output: 603

---

🏁 Script executed:

#!/bin/bash
# Find layout files
find . -name "*layout*" -o -name "*Layout*" | grep -v "node_modules" | grep -v ".git" | grep -E "\.(js|jsx|ts|tsx)$"

# Check app layout files that might be changed
git diff HEAD~1 HEAD -- "*layout*" "*Layout*" 2>/dev/null || echo "No direct layout file changes"

Length of output: 1321

---

🏁 Script executed:

#!/bin/bash
# Find files that import from @ably/ui 
grep -r "from '@ably/ui" --include="*.js" --include="*.jsx" --include="*.ts" --include="*.tsx" . | grep -v "node_modules" | head -10

# Check which of those files were modified
files=$(grep -r "from '@ably/ui" --include="*.js" --include="*.jsx" --include="*.ts" --include="*.tsx" . | grep -v "node_modules" | cut -d ":" -f1)
for file in $files; do
  if git diff --name-only HEAD~1 HEAD | grep -q "$file"; then
    echo "Modified file: $file"
    git diff HEAD~1 HEAD -- "$file"
  fi
done

Length of output: 29155

---

🏁 Script executed:

#!/bin/bash
# Search for files with Header in the name
find . -name "*header*" -o -name "*Header*" | grep -v "node_modules" | grep -v ".git"

# Look for Layout.jsx or similar files
find . -name "*Layout*.jsx" -o -name "*Layout*.tsx" | grep -v "node_modules" | grep -v ".git"

Length of output: 614

---

🏁 Script executed:

#!/bin/bash
# Check content of layout files
cat ./components/Layout.jsx

Length of output: 85

---

🏁 Script executed:

#!/bin/bash
# Check changes to Layout.jsx
git diff HEAD~1 HEAD -- ./components/Layout.jsx

Length of output: 78

---

🏁 Script executed:

#!/bin/bash
# Look for SessionState files
find . -name "*SessionState*" | grep -v "node_modules" | grep -v ".git"

# Grep for SessionState in all source files
grep -r "SessionState" --include="*.js" --include="*.jsx" --include="*.ts" --include="*.tsx" . | grep -v "node_modules" | head -10

Length of output: 817

---

🏁 Script executed:

#!/bin/bash
# Look for files that define or use SessionState
grep -r "SessionState" --include="*.js" --include="*.jsx" --include="*.ts" --include="*.tsx" . | grep -v "node_modules" | head -20

# Check content of Layout.jsx which uses Header
cat ./components/Layout.jsx

Length of output: 833

---

🏁 Script executed:

#!/bin/bash
# Look for auth or session related files
git diff --name-only HEAD~1 HEAD | grep -i "auth\|session" || echo "No direct auth/session file changes"

Length of output: 328

---

🏁 Script executed:

#!/bin/bash
# Search for logOut and accountName props
grep -r "logOut" --include="*.js" --include="*.jsx" --include="*.ts" --include="*.tsx" . | grep -v "node_modules" | head -10
grep -r "accountName" --include="*.js" --include="*.jsx" --include="*.ts" --include="*.tsx" . | grep -v "node_modules" | head -10

Length of output: 852

---

🏁 Script executed:

#!/bin/bash
# Look for API endpoint configurations
grep -r "ably-dev.com/api/me" --include="*.js" --include="*.jsx" --include="*.ts" --include="*.tsx" --include="*.json" . | grep -v "node_modules"

Length of output: 143

---

🏁 Script executed:

#!/bin/bash
# Look for API configuration files
find . -name "*api*" -o -name "*API*" | grep -v "node_modules" | grep -v ".git" | grep -E "\.(js|jsx|ts|tsx|json)$"

Length of output: 405

---

@aralovelace I've reviewed this PR which updates the @ably/ui package to version 15.6.0 and passes the logOut and accountName properties from SessionState to the Header component.

Key Changes

From examining the code and PR description, I can see that:

1. The @ably/ui package has been updated from 15.4.1 to 15.6.0
2. The Header component in src/components/Layout/Header.tsx has been configured to pass logOut and accountName properties from the SessionState to the Header component
3. Default values have been added to ensure proper initialization:

   logOut: userContext.sessionState.logOut ?? { token: '', href: '' },
   accountName: userContext.sessionState.accountName ?? '',
4. Documentation has been improved in the README.md and .env.example files

Regarding the API Error

For the issue you mentioned with https://ably-dev.com/api/me returning an error in the preview environment, this is likely an authentication configuration issue specific to the preview deployment. Since the new Header component expects authentication data to display the logout functionality correctly, this API error is preventing the feature from working as expected.

Possible causes:

1. Environment Configuration: The preview environment might have different API endpoint configurations or authentication settings than the local development environment.

2. CORS Issues: There could be cross-origin request issues specific to the preview domain.

3. Authentication Token: The authentication flow might be different or incomplete in the preview environment.

Recommendations:

1. Check the network tab in DevTools when accessing the preview site to see the specific error message returned by the API endpoint.

2. Verify that the preview environment has the correct authentication configurations for accessing the API.

3. If this is expected behavior for preview environments (where authentication might not be fully configured), you might want to consider adding a fallback or conditional rendering for the Header when in preview mode.

The code changes themselves look good - the issue appears to be with the environment configuration rather than the implementation.

✅ 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.

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (2)

README.md (2)

19-19: Grammar correction needed

The word "setup" is being used as a verb, but it should be "set up" when used as a verb.

-3. If this is the first time running the site, run `yarn run develop:env-setup` to setup your [environment variables](#environment-variables). Visit `localhost:8000` to view the site.
+3. If this is the first time running the site, run `yarn run develop:env-setup` to set up your [environment variables](#environment-variables). Visit `localhost:8000` to view the site.

🧰 Tools

🪛 LanguageTool

[grammar] ~19-~19: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...te, run yarn run develop:env-setup to setup your [environment variables](#environme...

(NOUN_VERB_CONFUSION)

🪛 markdownlint-cli2 (0.17.2)

19-19: Link fragments should be valid
null

(MD051, link-fragments)

---

31-40: Added Website Proxy documentation section

Good addition of documentation for the Website Proxy configuration, which will help developers understand how asset prefixing works during builds and how to set up their local environment correctly.

The section uses hard tabs instead of spaces for indentation, which is inconsistent with the rest of the document. Consider replacing the hard tabs with spaces:

-1.	Set the `ASSET_PREFIX=http://localhost:9000` variable in your environment.
-2.	Add `DOCS_BASE_URL=http://localhost:9000` to your `.env` file in the root of the Website app.
-3.	Ensure that `.env.production` exists in the app root for the Yarn build to function correctly.
-4.	You should be able to view the content and toggle between signed in and signed-out states.
+1. Set the `ASSET_PREFIX=http://localhost:9000` variable in your environment.
+2. Add `DOCS_BASE_URL=http://localhost:9000` to your `.env` file in the root of the Website app.
+3. Ensure that `.env.production` exists in the app root for the Yarn build to function correctly.
+4. You should be able to view the content and toggle between signed in and signed-out states.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

37-37: Hard tabs
Column: 3

(MD010, no-hard-tabs)

---

38-38: Hard tabs
Column: 3

(MD010, no-hard-tabs)

---

39-39: Hard tabs
Column: 3

(MD010, no-hard-tabs)

---

40-40: Hard tabs
Column: 3

(MD010, no-hard-tabs)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b3cc664 and d23942c.

⛔ Files ignored due to path filters (1)

• yarn.lock is excluded by !**/yarn.lock, !**/*.lock

📒 Files selected for processing (4)

• .env.example (1 hunks)
• README.md (2 hunks)
• package.json (1 hunks)
• src/components/Layout/Header.tsx (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• .env.example

🧰 Additional context used

🪛 LanguageTool

README.md

[grammar] ~19-~19: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...te, run yarn run develop:env-setup to setup your [environment variables](#environme...

(NOUN_VERB_CONFUSION)

🪛 markdownlint-cli2 (0.17.2)

README.md

19-19: Link fragments should be valid
null

(MD051, link-fragments)

---

37-37: Hard tabs
Column: 3

(MD010, no-hard-tabs)

---

38-38: Hard tabs
Column: 3

(MD010, no-hard-tabs)

---

39-39: Hard tabs
Column: 3

(MD010, no-hard-tabs)

---

40-40: Hard tabs
Column: 3

(MD010, no-hard-tabs)

🔇 Additional comments (3)

package.json (1)

42-42:

✅ Verification successful

Dependency update to @ably/ui 15.6.0

This update aligns with the PR objective to incorporate the enhanced Header component with dropdown and logout link functionality.

Let's verify that this version exists and check if there are any breaking changes or security issues:

---

🏁 Script executed:

#!/bin/bash
# Check if version 15.6.0 exists in npm registry
echo "Checking if @ably/ui v15.6.0 exists in npm registry:"
npm view @ably/ui versions --json | grep "15.6.0" || echo "Version not found"

# Check for changes between the versions
echo "Checking for changes between v15.4.1 and v15.6.0:"
npm view @ably/ui time --json | grep -E "15.4.1|15.5.0|15.5.1|15.6.0"

Length of output: 1100

---

Verified: Dependency @ably/ui updated to 15.6.0 is valid

The npm registry check confirms that version 15.6.0 exists, and the release timeline indicates a series of incremental updates from 15.4.1 to 15.6.0. There are no indications of breaking changes or security issues based on the published timestamps. This aligns with the PR’s objective of incorporating the enhanced Header component with the dropdown and logout link functionality.

• File: package.json, Line: 42

      "@ably/ui": "15.6.0",

src/components/Layout/Header.tsx (1)

18-19:

✅ Verification successful

Added default values for logOut and accountName

This change properly initializes the logOut and accountName properties when they're undefined in the context, which prevents potential runtime errors when these values are accessed by the Header component from the @ably/ui v15.6.0 package.

Let's check how these properties are used in the codebase:

---

🏁 Script executed:

#!/bin/bash
# Verify how the sessionState properties are used in the application
echo "Checking usage of sessionState in the codebase:"
rg -A 5 -B 5 "sessionState\s*=\s*{" --type tsx --type jsx

Length of output: 268

---

Below is a new shell script that uses a corrected regex pattern to check how the logOut and accountName properties from userContext.sessionState are used in the codebase. Please run these commands manually to verify that their usage aligns with the intended default values:

Default Value Initialization in Header.tsx

• File: src/components/Layout/Header.tsx (Lines 18-19)
• Changes:
  • logOut is initialized as:

        logOut: userContext.sessionState.logOut ?? { token: '', href: '' },
  • accountName is initialized as:

        accountName: userContext.sessionState.accountName ?? '',
• Rationale:
  These default values guarantee that even if the underlying properties are undefined, the Header component (used by the @ably/ui v15.6.0 package) safely receives valid values—thereby preventing potential runtime errors.

Please manually verify the usage of these properties across the codebase using the above script output and ensure consistency.

---

🏁 Script executed:

#!/bin/bash
echo "Checking usage of userContext.sessionState.logOut in the codebase:"
rg -A 5 -B 5 "userContext\.sessionState\.logOut" --type tsx --type jsx

echo "Checking usage of userContext.sessionState.accountName in the codebase:"
rg -A 5 -B 5 "userContext\.sessionState\.accountName" --type tsx --type jsx

Length of output: 624

---

Verification of Default Property Initialization in Header Component

The default values for logOut ({ token: '', href: '' }) and accountName ('') in src/components/Layout/Header.tsx (lines 18-19) properly ensure runtime stability by preventing potential errors when these values are undefined. An earlier attempt to verify their usage with file type filters resulted in errors due to unrecognized file types. The updated script above removes the file type restrictions, so please re-run these commands manually to verify that the properties are used as expected across the codebase.

---

🏁 Script executed:

#!/bin/bash
echo "Checking usage of userContext.sessionState.logOut in the codebase:"
rg -A 5 -B 5 "userContext\.sessionState\.logOut"

echo "Checking usage of userContext.sessionState.accountName in the codebase:"
rg -A 5 -B 5 "userContext\.sessionState\.accountName"

Length of output: 2279

---

Verified: Default Value Initialization in Header Component

The default values for logOut and accountName in src/components/Layout/Header.tsx (lines 18-19) have been verified as follows:

• Usage Confirmation:
  The shell script output confirms that logOut is initialized to { token: '', href: '' } and accountName to '', ensuring that even if these values are undefined in userContext.sessionState, they are safely defaulted, which prevents runtime errors.

• Location Check:
  Both properties are used correctly in the component, as seen in the shell script output for Header.tsx.

No further changes are required.

README.md (1)

15-21: Fixed step numbering in Run locally section

The step numbering has been corrected, which improves readability and makes the instructions clearer to follow.

🧰 Tools

🪛 LanguageTool

[grammar] ~19-~19: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...te, run yarn run develop:env-setup to setup your [environment variables](#environme...

(NOUN_VERB_CONFUSION)

🪛 markdownlint-cli2 (0.17.2)

19-19: Link fragments should be valid
null

(MD051, link-fragments)

[coderabbitai]

💡 Verification agent

🧩 Analysis chain

Invalid link fragment

The link to [environment variables](#environment-variables) points to a fragment that doesn't exist in the document.

Let's check if the environment variables section exists in the README:

---

🏁 Script executed:

#!/bin/bash
# Check if there's an environment variables section in the README
echo "Searching for environment variables section:"
grep -n "^##\s*Environment\s*Variables" README.md || echo "Section not found"

Length of output: 195

---

Action Required: Fix Invalid Link Fragment in README

The [environment variables](#environment-variables) link in README.md (line 19) is pointing to a non-existent section. Please either update the link to target an existing section or add an "Environment Variables" section to the document.

• Location: README.md, line 19
• Issue: The targeted fragment #environment-variables does not exist

🧰 Tools

🪛 LanguageTool

[grammar] ~19-~19: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...te, run yarn run develop:env-setup to setup your [environment variables](#environme...

(NOUN_VERB_CONFUSION)

🪛 markdownlint-cli2 (0.17.2)

19-19: Link fragments should be valid
null

(MD051, link-fragments)

[jamiehenson]

This makes sense, also the numbering needs to be fixed as we now have 1, 1, 2, 3, 4

[coderabbitai]

@jamiehenson You're absolutely right. The current diff has introduced a duplicate "1" in the numbered list, resulting in a "1, 1, 2, 3, 4" sequence instead of the proper "1, 2, 3, 4, 5" sequence. Since the first item (prerequisites) was already numbered as 1, the subsequent items should be 2, 3, 4, and 5 respectively to maintain correct sequential numbering.

[aralovelace]

thanks @jamiehenson I removed the targer fragment as the Environment Variables section has been removed.

[coderabbitai]

Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!

[jamiehenson]

Looks good, and we should also get the improved UX for the mobile menu in tablet view out with this as well (introduced in ably-ui 15.5).

Only thing here is to fix up the changes to the README - follow 🐰's suggestions (both the actionable suggestion, and the nitpick suggestions). I'll stamp after that