Skip to main content

Documentation Index

Fetch the complete documentation index at: https://fieldpulse.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

​
ET-453 — QA Notes (custom doc sidebar)

​
What was built

Doc pages now render a custom collapsible sidebar (docs-sidebar.js) that injects the home-page .hc-nav markup into #sidebar, hides the native Mintlify tree, and reuses the existing .hc-nav-* CSS — so the doc sidebar is visually identical to the landing sidebar. The redundant footer-nav.js doc-nav block is hidden (its categories now live in the sidebar).

​
Verified (local mint dev, Playwright + Chrome)

  • Injection: #sidebar.hc-docs-sidebar-active set, .hc-docs-nav present, native children display:none (0 visible).
  • Active state: /core-platform/customers/creating-customers → “Customers” highlighted; /core-platform/jobs → “Jobs”. Longest-prefix match resolves article → parent module.
  • Collapse: group header toggles .collapsed open/closed.
  • Item ③: clicking a group header does not navigate (URL unchanged) — folders only toggle.
  • SPA nav: clicking a topic navigates and the sidebar persists + active updates (MutationObserver).
  • Visual parity (computed styles, home vs doc): searchTrigger, groupHeader, groupHeaderSpan, topic, chevron all identical after fixes. Remaining diff: column width 288px (doc slot) vs 260px (home grid) — layout, not styling.
  • Dark mode: matches (light headers, muted links, aqua active highlight).
  • Footer: .fp-doc-nav-section display:none; footer columns (Features/Product/Company/Resources) still visible.

​
Fixes during QA

  1. Removed the native #sidebar lavender tint on our sidebar (background: transparent) — was the main visual mismatch vs home (which sits on plain paper).
  2. Set .hc-docs-nav { line-height: 1.65 } to match the home sidebar’s inherited rhythm (the #sidebar context was tighter, 21px vs 23.1px).

​
Screenshots

  • cmp-home.png / cmp-doc.png — light, side-by-side parity.
  • cmp-doc-dark.png — dark mode.
  • doc-sidebar-light.png / doc-sidebar-dark.png — full doc page context.

​
Still to do (this branch)

  • Item ② breadcrumb on article pages (.fp-breadcrumb).
  • Confirm card coverage so every article remains reachable by browsing.
  • Mobile / responsive pass.