docs: fix sidebar nav collapse behaviour and group the per-builder guides by amrit-agarwal-1 · Pull Request #697 · UiPath/uipath-typescript

amrit-agarwal-1 · 2026-08-31T06:30:25Z

Two changes to the docs sidebar.

1. Preserve collapse state across navigation

Collapsible sections re-expanded on every page load, so any section a reader collapsed sprang back open as soon as they navigated. navigation.expand renders every section with Material's md-toggle--indeterminate class, which the theme treats as expanded; the server re-emits it on each page load, discarding the reader's choice.

Removing the flag, plus a small script that remembers expand/collapse choices in sessionStorage, with the current page's ancestors pinned open so you can't hide where you are. State is fingerprinted so a nav-tree change drops stale entries, and all storage access is wrapped in try/catch.

2. Group the per-builder guides

The AI App Builders section lists one page per builder, so it grows every time we add one. navigation.sections prevents collapsing a top-level section, and removing it is a site-wide change we don't want — but it only applies at the top level, so one level down groups collapse normally (Coded Apps → CI/CD already does).

- AI App Builders:
    - Getting Started: ai-app-builders/getting-started.md
    - Guides:
        - Vercel (v0): ai-app-builders/vercel.md
        - Replit: ai-app-builders/replit.md
        - Bolt: ai-app-builders/bolt.md
        - Lovable: ai-app-builders/lovable.md

The section stays three rows however many builders we add, and the entry points stay visible.

Verification

Built and loaded in a browser: Guides renders as a collapsible node, not force-expanded, and the persistence script ships. The second change depends on the first — with navigation.expand still on, the new node would render permanently open.

Docs-site only — no SDK source, no public API surface.

🤖 Generated with Claude Code

claude · 2026-08-31T06:31:55Z

✅ No issues found. Checked for bugs and CLAUDE.md compliance.

github-actions · 2026-08-31T06:32:01Z

PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-09-09 08:07 UTC

claude · 2026-08-31T07:09:48Z

    - navigation.footer
    - navigation.indexes
-    - navigation.sections
    - navigation.top


The PR description says navigation.prune was also added ("so the full tree isn't rendered into every page"), but it isn't in the file. Without it, MkDocs renders the complete nav tree into every page's HTML — a non-trivial payload with 72 entries. Suggest adding it here:

Suggested change

- navigation.top

- navigation.prune

- navigation.top

claude · 2026-08-31T07:09:58Z

One finding this run: the PR description states navigation.prune was added (to prevent rendering the full nav tree in every page), but it is absent from mkdocs.yml. Flagged inline with a code suggestion.

claude · 2026-08-31T07:16:53Z

One new finding this run:

mkdocs.yml line 51 — navigation.sections is still present in both features blocks, but the PR description states it was dropped alongside navigation.expand. With navigation.sections enabled, Material renders top-level entries as fixed section headers with no toggle, so the JavaScript collapse-state persistence in extra.js cannot make them collapsible — navToggles() only captures nested input[id^="__nav"]\] elements that navigation.sections` prevents from existing at the top level. Flagged inline with a suggestion.

claude · 2026-08-31T07:36:27Z

✅ No issues found. Checked for bugs and CLAUDE.md compliance.

claude · 2026-08-31T07:42:57Z

✅ No issues found. Checked for bugs and CLAUDE.md compliance.

claude · 2026-08-31T08:12:44Z

One new finding this run:

docs/overrides/assets/javascripts/extra.js lines 243–245 and 264–266 — two bare catch {} blocks in readNavState and updateNavState swallow errors silently. CLAUDE.md requires console.warn(error) on any catch that doesn't re-throw, and explicitly names "best-effort reads from an ambient channel" (i.e. sessionStorage) as the canonical example. Flagged inline with code suggestions for both.

claude · 2026-08-31T08:47:06Z

✅ No issues found. Checked for bugs and CLAUDE.md compliance.

claude · 2026-08-31T08:51:52Z

✅ No issues found. Checked for bugs and CLAUDE.md compliance.

claude · 2026-09-02T08:28:27Z

✅ No issues found. Checked for bugs and CLAUDE.md compliance.

claude · 2026-09-08T05:56:20Z

✅ No issues found. Checked for bugs and CLAUDE.md compliance.

The docs sidebar re-expanded every collapsible section on each page load, so any section the reader collapsed sprang back open when they navigated. Two causes, two fixes: - `navigation.expand` was enabled in mkdocs.yml (listed twice, in a duplicated features block). It renders every section with Material's `md-toggle--indeterminate` class, which the theme's CSS treats exactly like `:checked`. Removed, so only the current page's ancestors open. - Material has no built-in persistence of manual expand/collapse, so extra.js now records explicitly-opened sections in sessionStorage and reapplies them per load, with a CSS rule suppressing the animation while state is restored. Also ignore the remaining generated API docs. `docs/api/` was already ignored while its sibling outputs from the same `npm run docs:api` command were not, so they showed up as untracked noise. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

…ible node The section lists a page per builder, so it grows with every builder we add. navigation.sections blocks collapsing a top-level section, but one level down groups collapse normally, so the per-builder pages move under a Guides node. The section stays three rows however many builders we add. Nav only — no theme flags, so nothing changes elsewhere on the site. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

Renames the nav section from AI App Builders to App Builder Integrations. The walkthroughs page moves to ai-app-builders/guides/index.md so it becomes the Guides section index, the same shape the API Reference uses for agents/. Clicking Guides opens it, and the four per-builder pages sit under it — no separate nav row for the page itself. Its URL changes from /ai-app-builders/videos/ to /ai-app-builders/guides/. The per-builder pages keep their URLs. Cross-links updated on the four guide pages, Getting Started, the Codex plugin page, and the Coded Apps CLI reference. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

Both catches around sessionStorage returned silently. agent_docs/ conventions.md requires a console.warn on any catch that does not re-throw, naming best-effort reads from an ambient channel as the case. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

claude · 2026-09-08T18:32:05Z

✅ No issues found. Checked for bugs and CLAUDE.md compliance.

sonarqubecloud · 2026-09-09T05:56:53Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

amrit-agarwal-1 requested a review from a team August 31, 2026 06:30

amrit-agarwal-1 force-pushed the docs/nav-collapsible branch from 3ad26fa to ac3a001 Compare August 31, 2026 07:05

claude Bot reviewed Aug 31, 2026

View reviewed changes

amrit-agarwal-1 force-pushed the docs/nav-collapsible branch from ac3a001 to cc18770 Compare August 31, 2026 07:12

claude Bot reviewed Aug 31, 2026

View reviewed changes

Comment thread mkdocs.yml

amrit-agarwal-1 force-pushed the docs/nav-collapsible branch from cc18770 to 4504cb3 Compare August 31, 2026 07:33

amrit-agarwal-1 changed the title ~~docs: make the sidebar sections collapsible~~ docs(ai-app-builders): group the per-builder guides under one collapsible node Aug 31, 2026

amrit-agarwal-1 force-pushed the docs/nav-collapsible branch from 4504cb3 to 30a7393 Compare August 31, 2026 07:38

amrit-agarwal-1 changed the title ~~docs(ai-app-builders): group the per-builder guides under one collapsible node~~ docs: fix sidebar nav collapse behaviour and group the per-builder guides Aug 31, 2026

claude Bot reviewed Aug 31, 2026

View reviewed changes

Comment thread docs/overrides/assets/javascripts/extra.js Outdated

amrit-agarwal-1 force-pushed the docs/nav-collapsible branch 2 times, most recently from e12139f to bd052b3 Compare August 31, 2026 08:43

amrit-agarwal-1 force-pushed the docs/nav-collapsible branch from bd052b3 to 081a98c Compare August 31, 2026 08:48

Raina451 reviewed Sep 2, 2026

View reviewed changes

Comment thread docs/overrides/assets/javascripts/extra.js

amrit-agarwal-1 requested a review from Raina451 September 2, 2026 08:32

Raina451 approved these changes Sep 4, 2026

View reviewed changes

amrit-agarwal-1 force-pushed the docs/nav-collapsible branch from 44e47a8 to f818c58 Compare September 8, 2026 05:52

Sarath1018 mentioned this pull request Sep 8, 2026

test(data-fabric): fix integration-test design flaws behind transient failures #723

Merged

amrit-agarwal-1 and others added 3 commits September 8, 2026 23:57

Sarath1018 force-pushed the docs/nav-collapsible branch from f818c58 to 9baeeda Compare September 8, 2026 18:27

Sarath1018 approved these changes Sep 9, 2026

View reviewed changes

amrit-agarwal-1 merged commit 18938f9 into main Sep 9, 2026
42 of 58 checks passed

amrit-agarwal-1 deleted the docs/nav-collapsible branch September 9, 2026 08:07

Uh oh!

Conversation

amrit-agarwal-1 commented Aug 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

1. Preserve collapse state across navigation

2. Group the per-builder guides

Verification

Uh oh!

claude Bot commented Aug 31, 2026

Uh oh!

github-actions Bot commented Aug 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

claude Bot Aug 31, 2026

Choose a reason for hiding this comment

Uh oh!

claude Bot commented Aug 31, 2026

Uh oh!

Uh oh!

claude Bot commented Aug 31, 2026

Uh oh!

claude Bot commented Aug 31, 2026

Uh oh!

claude Bot commented Aug 31, 2026

Uh oh!

Uh oh!

claude Bot commented Aug 31, 2026

Uh oh!

claude Bot commented Aug 31, 2026

Uh oh!

claude Bot commented Aug 31, 2026

Uh oh!

Uh oh!

claude Bot commented Sep 2, 2026

Uh oh!

claude Bot commented Sep 8, 2026

Uh oh!

claude Bot commented Sep 8, 2026

Uh oh!

sonarqubecloud Bot commented Sep 9, 2026

Quality Gate passed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

amrit-agarwal-1 commented Aug 31, 2026 •

edited

Loading

github-actions Bot commented Aug 31, 2026 •

edited

Loading