Skip to content

Docs site overhaul + Settings row help/update popover#6

Merged
robert-sure merged 1 commit into
mainfrom
docs/website-overhaul
May 31, 2026
Merged

Docs site overhaul + Settings row help/update popover#6
robert-sure merged 1 commit into
mainfrom
docs/website-overhaul

Conversation

@tomisnotme
Copy link
Copy Markdown
Contributor

Summary

  • Docs IA overhaul: restructured into 5 sections (Get Started / Agent / Explorer / Console / Reference). Tech Plan Reviews → Explorer, Chrome extension → Console.
  • Fact-checked rewrite of ~30 doc pages against actual product code (engines, console bubbles, explorer modules, agent panels, CLI, FAQ, keyboard shortcuts, etc.).
  • Sidebar UX polish: persistent across navigation (scrollTop preserved), `scroll-padding-top: 4rem` fixes sticky-Nav title clipping, scrollbar hidden on sidebar only.
  • Settings row enhancements: inline Help (?) link (locale follows i18n), version-update pill + popover (copy `cockpit update` + view changelog), client-side npm registry check with dev preview override.

Scope

Area Changes
`website/` Full docs IA + sidebar layout + persistent sidebar component + scroll-padding fix + scrollbar-hide utility
`packages/feature/workspace/` ProjectSidebar Settings row: Help button + version pill + popover; new `useLatestVersion` hook
`packages/shared/i18n/` 6 new `workspace.*` keys (zh + en) for help/update flow
`packages/feature/agent/`, `explorer/` Drive-by fixes already on this branch

Test plan

  • `npm run dev` — docs site loads, sidebar persists on navigation
  • Scroll to bottom of a doc, click sidebar link → new title fully visible (not under sticky Nav)
  • Sidebar scrollbar hidden; window scrollbar still visible
  • Settings row shows Settings + Help (?); collapsed sidebar shows gear only (with red dot when update available)
  • Help link opens `/zh/docs/get-started/quickstart/` or `/en/...` based on current i18n language
  • In dev mode, version pill `v999.0.0` then real npm latest renders, popover opens to right-top
  • Copy command toast fires; changelog link opens correct locale
  • All ~30 rewritten doc pages render without broken anchors or links
  • No broken cross-doc links between moved files (`reference/chrome-extension` → `console/chrome-extension`, `reference/reviews` → `explorer/reviews`)

🤖 Generated with Claude Code

Docs site (website/):
- Restructure IA into 5 sections: Get Started / Agent / Explorer /
  Console / Reference. Tech Plan Reviews moved under Explorer, Chrome
  extension moved under Console.
- Convert all docs MDX -> MD; persist sidebar across navigation
  (preserves scrollTop) by hoisting it into the docs layout.
- Fact-check rewrite of ~30 doc pages against actual product code.
  Touched: introduction, quickstart, message-input, sessions, skills,
  engines, scheduled-tasks, notes, file-tree, search, recent, changes,
  history, reviews, input-bar, terminal, browser, databases, jupyter,
  aliases-env, cli, chrome-extension, keyboard-shortcuts, faq.
- scroll-padding-top: 4rem on <html> so titles aligned by App Router's
  scrollIntoView don't tuck under the sticky Nav.
- .scrollbar-hide utility, applied to docs sidebar only (window scroll
  bar kept as reading-position indicator).

Workspace (packages/feature/workspace/):
- Settings row: integrate Help (?) link (locale follows i18n.language)
  as a secondary action inside the same row, ProjectItem-style.
- Add version-update pill + popover (Copy `cockpit update`, View
  changelog) driven by useLatestVersion hook (client-side npm registry
  fetch with 3s timeout + silent failure).
- Dev-mode override forces hasUpdate=true so the UI can be previewed
  without a real npm publish. Production builds dead-code-eliminate it.
- Popover anchors to the pill's top-right so it floats into the main
  panel rather than clipping against the sidebar's left edge.
- Collapsed sidebar: gear icon shows a red dot when an update is
  available (only signal that fits in icon-only mode).

i18n (packages/shared/i18n/):
- 6 new workspace.* keys: help, updateAvailable, copyUpgradeCommand,
  viewChangelog, upgradeCommandCopied (zh + en).

Engine / scheduled-task / file browser drive-by fixes (unrelated to
the docs work but were already on this branch).

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@robert-sure robert-sure merged commit c3d46e7 into main May 31, 2026
6 checks passed
@robert-sure robert-sure deleted the docs/website-overhaul branch May 31, 2026 14:45
tomisnotme added a commit that referenced this pull request May 31, 2026
…ate (#6)

Docs site (website/):
- Restructure IA into 5 sections: Get Started / Agent / Explorer /
  Console / Reference. Tech Plan Reviews moved under Explorer, Chrome
  extension moved under Console.
- Convert all docs MDX -> MD; persist sidebar across navigation
  (preserves scrollTop) by hoisting it into the docs layout.
- Fact-check rewrite of ~30 doc pages against actual product code.
  Touched: introduction, quickstart, message-input, sessions, skills,
  engines, scheduled-tasks, notes, file-tree, search, recent, changes,
  history, reviews, input-bar, terminal, browser, databases, jupyter,
  aliases-env, cli, chrome-extension, keyboard-shortcuts, faq.
- scroll-padding-top: 4rem on <html> so titles aligned by App Router's
  scrollIntoView don't tuck under the sticky Nav.
- .scrollbar-hide utility, applied to docs sidebar only (window scroll
  bar kept as reading-position indicator).

Workspace (packages/feature/workspace/):
- Settings row: integrate Help (?) link (locale follows i18n.language)
  as a secondary action inside the same row, ProjectItem-style.
- Add version-update pill + popover (Copy `cockpit update`, View
  changelog) driven by useLatestVersion hook (client-side npm registry
  fetch with 3s timeout + silent failure).
- Dev-mode override forces hasUpdate=true so the UI can be previewed
  without a real npm publish. Production builds dead-code-eliminate it.
- Popover anchors to the pill's top-right so it floats into the main
  panel rather than clipping against the sidebar's left edge.
- Collapsed sidebar: gear icon shows a red dot when an update is
  available (only signal that fits in icon-only mode).

i18n (packages/shared/i18n/):
- 6 new workspace.* keys: help, updateAvailable, copyUpgradeCommand,
  viewChangelog, upgradeCommandCopied (zh + en).

Engine / scheduled-task / file browser drive-by fixes (unrelated to
the docs work but were already on this branch).

Co-authored-by: robert <robert@surething.io>
Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
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.

2 participants