Skip to content

feat(handbook): navigable, searchable handbook with callouts, FAQ and figure lightbox - #59

Merged
karlitschek merged 1 commit into
mainfrom
feat/handbook-navigation-and-callouts
Aug 20, 2026
Merged

feat(handbook): navigable, searchable handbook with callouts, FAQ and figure lightbox#59
karlitschek merged 1 commit into
mainfrom
feat/handbook-navigation-and-callouts

Conversation

@karlitschek

Copy link
Copy Markdown
Member

Turns the handbook from one long scroll into something that reads like real product documentation. All four improvements from the wishlist:

Navigation

  • Sticky sidebar TOC with scroll-spy — the chapter you're reading is highlighted as you scroll. Collapses to a chip row on narrow screens.
  • Shareable deep links…/handbook?s=requesting scrolls straight to that chapter on load, and every heading gets a hover 🔗 copy-link.

Search

  • Live filter over chapter titles and body text as you type; / focuses the box, Esc clears, with a "nothing matches" note.

Scannability

  • Callout boxes (tip / note / privacy / warning) lift the key points out of the prose: a 30-second Quick start, the confidentiality guarantees, the overlap/past-date rules, and the "verify the working-day count" warning.
  • FAQ chapter — the real questions ("How many days do I have left?", "Can I cancel approved leave?", "Who sees my sick leave?"), with HR-only entries added on the HR route.

Polish

  • Figure lightbox — click any figure (including the dense dashboards and the animated walkthroughs) to view it full-screen.
  • Scroll-reveal as chapters enter, a Print button + print stylesheet for a clean handout. Everything is prefers-reduced-motion-aware.

New reusable Callout.vue; the handbook prose and figures are unchanged in wording. Verified on the dev instance: sidebar/scroll-spy, search (carry-over → the 4 chapters that mention it), deep links, copy-anchors, lightbox, and print all work. eslint 0 errors, stylelint clean, build ✓.

🤖 Generated with Claude Code

… figure lightbox

Turns the handbook from one long scroll into proper product documentation:

- Sticky sidebar table of contents with scroll-spy — the current chapter is
  highlighted as you read. Collapses to a chip row on narrow screens.
- Live search that filters chapters (title + body) as you type; "/" focuses it,
  Esc clears, with a no-results note.
- Shareable deep links (/handbook?s=requesting scrolls straight there) and a
  hover "copy link" affordance on every chapter heading.
- Callout boxes (tip / note / privacy / warning) lift the key points out of the
  prose — a 30-second "quick start", the confidentiality guarantees, the
  overlap/past-date rules, and the "verify the working-day count" warning.
- An FAQ chapter answering the real questions ("how many days do I have left?",
  "can I cancel approved leave?", "who sees my sick leave?"), with HR-only
  entries added on the HR route.
- Click any figure to open it in a full-screen lightbox (the dense dashboards
  and the animated walkthroughs are finally readable at full size).
- Subtle scroll-reveal as chapters enter, and a Print button + print stylesheet
  for a clean handout. All reduced-motion-aware.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@nextcloud-command nextcloud-command added the AI assisted This PR contains AI-assisted commits label Aug 20, 2026
@karlitschek
karlitschek merged commit 0d84f4d into main Aug 20, 2026
21 of 31 checks passed
@karlitschek
karlitschek deleted the feat/handbook-navigation-and-callouts branch August 20, 2026 19:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

AI assisted This PR contains AI-assisted commits

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants