Skip to content

Conversation

@jamiehenson
Copy link
Member

@jamiehenson jamiehenson commented Dec 2, 2025

Human preamble

Addresses Jamie W's feedback here, plus subsequent feedback from Mark and Jamie in DMs.

To test the intro content in PageHeader, go here, it's the only page with the intro frontmatter populated.

Summary

This PR addresses design feedback and fixes for the docs redesign, implementing various UI/UX improvements and refinements to the core navigation components.

Changes

Inkeep Integration

  • Changed default mode to "Ask AI" (chat mode) instead of search
  • Removed bottom-right Inkeep button

Left Sidebar Improvements

  • Fixed item highlighting behavior to properly respect accordion open/active page state
  • Restored pre-expandable left sidebar section functionality
  • Fixed accordion animation to work for both expansion and contraction

UI/UX Fixes

  • Made all breadcrumb chevrons use neutral-900 color consistently
  • Reintroduced API reference content into LeftSidebar
  • Capped max width of inner container to 1280px for better content layout
  • Reduced right sidebar highlighter width to 1px for better visibility
  • Fixed LanguageSelector to only show arrow and dropdown when >1 language available

Content & Configuration

  • Removed Article Footer unit
  • Updated PageHeader to source description from intro field in frontmatter
  • Added temporary intro frontmatter to chat/rooms/messages page

Analytics

  • Added event tracking for header button clicks (Ask AI, Help Resources, CLI, Logout)

Code Cleanup

  • Removed breadcrumbs console.log
  • Cleaned up unused Inkeep configuration code

Test plan

  • Verify header button click tracking is working (Ask AI, Help Resources, CLI, Logout)
  • Test left sidebar accordion animations work smoothly in both directions
  • Test left sidebar highlighting behavior with nested items and accordion states
  • Verify left sidebar pre-expandable section functionality works
  • Check content max-width constraint on large screens (1280px)
  • Verify right sidebar active section indicator is visible (1px width)
  • Verify breadcrumbs display correctly and all chevrons are neutral-900
  • Verify language selector arrow only appears when multiple languages available
  • Test Inkeep opens in chat ("Ask AI") mode by default
  • Verify bottom-right Inkeep button is removed
  • Verify API reference content displays in left sidebar
  • Test PageHeader displays intro frontmatter content
  • Confirm Article Footer is removed

🤖 Generated with Claude Code

@coderabbitai
Copy link

coderabbitai bot commented Dec 2, 2025

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.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch web-4801-misc-docs-tweaks

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

@jamiehenson jamiehenson changed the title Miscellaneous docs UI improvements [WEB-4801] Initial docs rewrite design feedback fixes Dec 2, 2025
@jamiehenson jamiehenson added the review-app Create a Heroku review app label Dec 2, 2025
@ably-ci ably-ci temporarily deployed to ably-docs-web-4801-misc-mnrlt9 December 2, 2025 14:45 Inactive
@jamiehenson jamiehenson marked this pull request as ready for review December 2, 2025 14:48
@jamiehenson jamiehenson temporarily deployed to ably-docs-web-4801-misc-mnrlt9 December 2, 2025 15:02 Inactive
@jamiehenson jamiehenson force-pushed the web-4801-misc-docs-tweaks branch from af1d1a8 to 829989b Compare December 2, 2025 15:11
@jamiehenson jamiehenson temporarily deployed to ably-docs-web-4801-misc-mnrlt9 December 2, 2025 15:13 Inactive
@jamiehenson jamiehenson temporarily deployed to ably-docs-web-4801-misc-mnrlt9 December 2, 2025 15:14 Inactive
@jamiehenson jamiehenson temporarily deployed to ably-docs-web-4801-misc-mnrlt9 December 2, 2025 15:25 Inactive
@jamiehenson jamiehenson force-pushed the web-4801-admonitions-tables branch from 4d66a25 to 9368377 Compare December 3, 2025 12:52
Base automatically changed from web-4801-admonitions-tables to web-4684-docs-redesign December 3, 2025 13:04
@jamiehenson jamiehenson force-pushed the web-4684-docs-redesign branch from 382e677 to 1935e45 Compare December 3, 2025 13:05
@jamiehenson jamiehenson force-pushed the web-4801-misc-docs-tweaks branch from 829989b to 991a9be Compare December 3, 2025 13:06
@jamiehenson jamiehenson temporarily deployed to ably-docs-web-4801-misc-mnrlt9 December 3, 2025 13:06 Inactive
@jamiehenson jamiehenson force-pushed the web-4801-misc-docs-tweaks branch from 991a9be to cc4e712 Compare December 3, 2025 13:07
@jamiehenson jamiehenson temporarily deployed to ably-docs-web-4801-misc-mnrlt9 December 3, 2025 13:07 Inactive
@jamiehenson jamiehenson marked this pull request as draft December 4, 2025 14:31
@jamiehenson jamiehenson temporarily deployed to ably-docs-web-4801-misc-mnrlt9 December 4, 2025 14:31 Inactive
@jamiehenson jamiehenson force-pushed the web-4801-misc-docs-tweaks branch from 8526f68 to 29484d9 Compare December 4, 2025 14:39
@jamiehenson jamiehenson temporarily deployed to ably-docs-web-4801-misc-mnrlt9 December 4, 2025 14:39 Inactive
---
title: Messages
meta_description: "Send, update, delete, and receive messages in chat rooms."
intro: "Send, update, delete, and receive messages in chat rooms."
Copy link
Member Author

Choose a reason for hiding this comment

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

temporary - here to show intro off - will be removed.

@jamiehenson jamiehenson temporarily deployed to ably-docs-web-4801-misc-mnrlt9 December 5, 2025 14:33 Inactive
@jamiehenson jamiehenson temporarily deployed to ably-docs-web-4801-misc-mnrlt9 December 5, 2025 14:53 Inactive
@jamiehenson jamiehenson temporarily deployed to ably-docs-web-4801-misc-mnrlt9 December 5, 2025 15:13 Inactive
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