[FTF-426] Post-nav launch fixes by jamiehenson · Pull Request #3022 · ably/docs

jamiehenson · 2025-12-12T14:30:04Z

The ticket namesake for this PR is FTF-426, which reintroduces the external link icon to links in the left nav which go off-site.

Additionally, the PR includes the following items as rapid hotfixes to the launch of the new nav:

fixes an issue raised by @VeskeR whereby the inkeep form rerendered on top of itself multiple times when pressing "Cmd+K" (now it's just the once, in default Search mode)
rips out a bunch of old, unused SearchBar component logic and nav config
adds a "Markdown" section to the PageHeader including links to both view and copy the related page markdown content (made possible now via [WEB-4447] Add MDX to Markdown transpilation with content negotiation #3000)

includes intro frontmatter in generated markdown content as a paragraph
actually hooks up the logout button to log the user out, whereas before it was an overlooked stub
when navigating between pages, the leftsidebar scrolls to the relevant item. Issue is that this also affected the main page scrolling - no more

To test, go on the review app and:

expand the left nav and expand Spaces > API References. The link within should have an external icon, and it should open in a new tab
press cmd+k, you should only get one inkeep form
look at any page, you should get a "Markdown" section in the page header, and the view and copy buttons should work as expected
in the generated markdown, we should have the intro frontmatter (might be hard to test, not sure which pages currently have an intro)
navigate between pages using the left nav, ensure that the main page scrolling is not impacted
for the logout button, hard to test, but the logic is fairly standard and it's better than the current state

coderabbitai · 2025-12-12T14:30:12Z

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 ftf-426-external-icon

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

jamiehenson · 2025-12-12T14:49:21Z

data/createPages/index.ts

 import { DEFAULT_LANGUAGE } from './constants';
 import { writeRedirectToConfigFile, getRedirectCount } from './writeRedirectToConfigFile';
 import { siteMetadata } from '../../gatsby-config';
-import { GatsbyNode, Reporter } from 'gatsby';


This wasn't used

jamiehenson · 2025-12-12T14:49:36Z

data/createPages/index.ts

          contentOrderedList,
          contentMenu: contentMenuObject,
          script,
-          layout: { leftSidebar: true, rightSidebar: true, searchBar: true, template: 'base' },


searchBar no longer used

jamiehenson · 2025-12-12T14:50:30Z

data/onPostBuild/transpileMdxToMarkdown.ts


  // Stage 9: Prepend title as markdown heading
-  const finalContent = `# ${title}\n\n${content}`;
+  const finalContent = `# ${title}\n\n${intro ? `${intro}\n\n` : ''}${content}`;


All other changes here are prettier - this is the key change.

jamiehenson · 2025-12-12T14:51:02Z

src/components/Layout/Header.tsx

+  const handleLogout = useCallback(async () => {
+    if (sessionState.logOut.href && sessionState.logOut.token) {
+      try {
+        await fetch(sessionState.logOut.href, {


Replicates the hidden form approach of logging out elsewhere

jamiehenson · 2025-12-12T14:51:30Z

src/components/Layout/LeftSidebar.tsx

-          behavior: 'smooth',
-          block: 'center',
-        });
+        const element = activeTriggerRef.current;


Instead of scrollIntoView, which takes the whole page, localise the scrolling to a particular container housing the nav

…rd shortcut

kennethkalmer

Initial feedback, I'm reconfiguring the review app to have inkeep enabled

kennethkalmer · 2025-12-12T15:04:37Z

data/onPostBuild/__fixtures__/input.mdx

-  Multi-line JSX comment
-  with multiple lines
-*/}
+{/_


[question] unexpected changes from Prettier?

Yep, Prettier butchered it. I've ignored this file in the config for now, and will review from here how it does with other MDX files (didn't want to disable it wholesale for MDX files)

src/components/Layout/mdx/PageHeader.tsx

kennethkalmer · 2025-12-12T15:09:08Z

src/components/Layout/LeftSidebar.tsx

                    )}
                    tabIndex={-1}
+                    {...(page.external && {
+                      target: '_blank',


[observation] the Spaces > API References > JavaScript link has the icon, but it doesn't open a in a new window 🤔

Sorry, I did the classic "request review but notice an issue and push after it", this should be in place now

aka Fridays

kennethkalmer · 2025-12-12T15:13:30Z

@jamiehenson it looks great btw, apologies for the terse comment earlier

…lector size to 32px

jamiehenson · 2025-12-12T15:38:51Z

@jamiehenson it looks great btw, apologies for the terse comment earlier

Unaware of the comment, but thanks! Ready for another round

kennethkalmer

Thing of beauty

kennethkalmer · 2025-12-12T15:39:24Z

src/components/Layout/mdx/PageHeader.tsx

+      }
+
+      const content = await response.text();
+      await navigator.clipboard.writeText(content);


Sadly in Safari this doesn't work, I get NotAllowedError: The request is not allowed by the user agent or the platform in the current context, possibly because the user denied permission logged in the console. That said I think that can be a separate fix as it works in Firefox

We have to pay for the peace offering one way or another 🙄

jamiehenson added the review-app Create a Heroku review app label Dec 12, 2025

ably-ci temporarily deployed to ably-docs-ftf-426-exter-lfvs3o December 12, 2025 14:30 Inactive

jamiehenson force-pushed the ftf-426-external-icon branch from f21a3ae to 2742567 Compare December 12, 2025 14:31

jamiehenson temporarily deployed to ably-docs-ftf-426-exter-lfvs3o December 12, 2025 14:31 Inactive

jamiehenson temporarily deployed to ably-docs-ftf-426-exter-lfvs3o December 12, 2025 14:41 Inactive

jamiehenson changed the title ~~[FTF-426] Post-nav launch fixes, including reintroduction of external link icon~~ [FTF-426] Post-nav launch fixes Dec 12, 2025

jamiehenson force-pushed the ftf-426-external-icon branch from dd8112a to 8115a37 Compare December 12, 2025 14:48

jamiehenson temporarily deployed to ably-docs-ftf-426-exter-lfvs3o December 12, 2025 14:49 Inactive

jamiehenson commented Dec 12, 2025

View reviewed changes

jamiehenson requested review from kennethkalmer and m-hulbert December 12, 2025 14:54

jamiehenson added 3 commits December 12, 2025 15:01

fix: add external icon to external nav links

0567151

fix: prevent multiple rerenders of the inkeep popup when using keyboa…

f923380

…rd shortcut

chore: remove unused searchbar assets and config

6c8e13e

jamiehenson force-pushed the ftf-426-external-icon branch from 8115a37 to 33ca7c8 Compare December 12, 2025 15:01

jamiehenson temporarily deployed to ably-docs-ftf-426-exter-lfvs3o December 12, 2025 15:01 Inactive

kennethkalmer reviewed Dec 12, 2025

View reviewed changes

kennethkalmer temporarily deployed to ably-docs-ftf-426-exter-lfvs3o December 12, 2025 15:12 Inactive

jamiehenson added 2 commits December 12, 2025 15:16

feat: add markdown view/copy links to pageheader, condense languagese…

5dc8733

…lector size to 32px

fix: actually hook up logout button

a3ee0a1

jamiehenson force-pushed the ftf-426-external-icon branch from 33ca7c8 to 52eca7d Compare December 12, 2025 15:16

jamiehenson temporarily deployed to ably-docs-ftf-426-exter-lfvs3o December 12, 2025 15:16 Inactive

jamiehenson force-pushed the ftf-426-external-icon branch from 52eca7d to 4e40cf6 Compare December 12, 2025 15:28

jamiehenson temporarily deployed to ably-docs-ftf-426-exter-lfvs3o December 12, 2025 15:28 Inactive

jamiehenson added 2 commits December 12, 2025 15:29

chore: include intro in generated md for pages

085e95d

fix: isolate main page body from leftnav scroll-into-view behaviour

78afeab

jamiehenson force-pushed the ftf-426-external-icon branch from 4e40cf6 to 78afeab Compare December 12, 2025 15:29

jamiehenson temporarily deployed to ably-docs-ftf-426-exter-lfvs3o December 12, 2025 15:30 Inactive

jamiehenson requested a review from kennethkalmer December 12, 2025 15:38

kennethkalmer approved these changes Dec 12, 2025

View reviewed changes

jamiehenson merged commit 350ef73 into main Dec 12, 2025
7 checks passed

jamiehenson deleted the ftf-426-external-icon branch December 12, 2025 15:42

Conversation

jamiehenson commented Dec 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Dec 12, 2025

Review skipped

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kennethkalmer left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kennethkalmer commented Dec 12, 2025

Uh oh!

jamiehenson commented Dec 12, 2025

Uh oh!

kennethkalmer left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

jamiehenson commented Dec 12, 2025 •

edited

Loading