Skip to content

site: split docs into 4 pages, fix nav consistency, add notebook mock - #148

Merged
AkashGoenka merged 1 commit into
mainfrom
site/docs-declutter-and-nav-fixes
Aug 10, 2026
Merged

site: split docs into 4 pages, fix nav consistency, add notebook mock#148
AkashGoenka merged 1 commit into
mainfrom
site/docs-declutter-and-nav-fixes

Conversation

@AkashGoenka

Copy link
Copy Markdown
Owner

Summary

Response to a friend's review pass on the marketing site.

  • Split the single /docs/ page into /docs/, /docs/navigation/, /docs/notebook/, /docs/under-the-hood/ — nextjs.org-style progressive-disclosure sidebar, content trimmed, single accent color, de-boxed UI.
  • Fixed header inconsistency between landing and docs pages (nav CSS had drifted: 60px vs 64px height, different gap/z-index).
  • Fixed docs sidebar's active group header double-boxing bug.
  • Removed arbitrary "hot" color tier on supported-language chips.
  • Reverted npm nav link to plain text; fixed a terminal-block line-collapse rendering bug.
  • Added a hand-built HTML/CSS recreation of the notebook's kb view UI to /how-it-works/notebook/ (not a screenshot — matches the site's existing built-UI pattern).
  • Landing hero copy tightened; new /vs/vector-rag/ comparison page.
  • Fixed .gitignore: an unanchored docs/ pattern (meant for the repo-root internal-docs folder) was silently excluding site-astro/src/pages/docs/ from git.

Test plan

  • npm run build — 20 pages, no errors
  • Screenshot-verified desktop: home, /docs/, /docs/navigation/, /docs/notebook/, /docs/under-the-hood/, /how-it-works/notebook/
  • Screenshot-verified mobile (390×844): home, /docs/ + mobile menu, /docs/under-the-hood/ languages, /how-it-works/notebook/ notebook mock (sidebar correctly hides below 640px)
  • Broken-anchor-link audit across the whole site after the docs split

🤖 Generated with Claude Code

Addresses a friend's review pass on the marketing site:

- Split the single /docs/ page (25k px, everything on one page) into
  /docs/ (getting started), /docs/navigation/, /docs/notebook/, and
  /docs/under-the-hood/, each with its own collapsed-by-default sidebar
  (nextjs.org-style) instead of one long list of every anchor at once.
  /how-it-works/* stays as-is and is cross-linked from each new page —
  it's genuinely different narrative content, not a duplicate.
- Content trimmed nextjs-style: long paragraphs cut to 1-2 sentences,
  edge cases moved into flag-row tables; README/GitHub stays the source
  of truth for exhaustive detail.
- Single accent color (frost) everywhere; removed the ember "warm"
  variant on command names/callouts and the arbitrary "hot" highlight
  tier on the supported-languages chips, both of which read as noise
  rather than signal.
- De-boxed flag/callout UI (lighter borders, no nested boxes).
- Fixed docs.css's nav rules drifting from landing.css (60px vs 64px
  height, different gap/z-index/mobile offsets) — the header was
  visibly resizing when navigating between the landing page and docs.
- Fixed the docs sidebar's active group header picking up the same
  boxed/active styling as its active sub-link (both matched the global
  `.side a.active` rule), producing two stacked highlight boxes.
- Reverted the npm nav link from an SVG icon back to plain text.
- Terminal command blocks: fixed sibling `<span class="ln">` lines
  collapsing onto one row (missing `display: block`).
- Added a hand-built (not screenshotted) HTML/CSS recreation of the
  notebook's `kb view` UI to /how-it-works/notebook/, grounding the
  loop explanation in what a real note looks like.
- Landing hero copy tightened; new /vs/vector-rag/ comparison page.

Verified via production build + chrome-devtools screenshots (desktop
and mobile) on all touched pages.

Also fixed .gitignore: an unanchored `docs/` pattern meant for the
repo-root internal-docs folder was silently matching and excluding
site-astro/src/pages/docs/ from git entirely. Anchored it to `/docs/`.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@AkashGoenka
AkashGoenka merged commit 7e078b8 into main Aug 10, 2026
6 checks passed
@AkashGoenka
AkashGoenka deleted the site/docs-declutter-and-nav-fixes branch August 10, 2026 18:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant