Repository navigation
docs(web): document session list and search behavior - #1984
techotaku39 wants to merge 3 commits into
Conversation
There was a problem hiding this comment.
Review mode: initial
Requirement — Pass
A user-facing guide is justified because session ordering, search ranking, and picker policies differ in ways users need to understand.
Evidence
- The snapshot PR description identifies confusion about relevance versus recency and differences between session pickers.
- web/src/lib/sessionListSearch.ts, web/src/lib/sharePickerSessions.ts, and web/src/lib/sessionReference.ts implement distinct ranking policies.
Approach — Pass
A dedicated guide linked from the documentation navigation, Web README, and PWA guide appropriately documents existing behavior without changing runtime logic.
Evidence
- The complete merge-base diff changes only docs/.vitepress/config.ts, docs/guide/pwa.md, docs/guide/session-list.md, and web/README.md.
Code — Reviewed
Reviewed the entire fixed-head diff against the relevant implementation. One documentation correction is needed for search-result expansion.
- [Minor] Distinguish project collapse from preview pagination —
docs/guide/session-list.md:59
Testing
Not run (automation; PR code execution is prohibited).
- Static diff and local link-target inspection completed; git diff --check passed. No PR code, tests, builds, or scripts were executed.
- Observed CI: integration and windows-codex-mcp succeeded; test remained in progress.
- The PR description reports successful typechecking and builds, plus 11 CLI test failures attributed by the author to existing platform/environment cases; those claims were not independently reproduced.
HAPI Bot
|
|
||
| Search preserves the session-list structure: pinned rows remain contiguous and | ||
| project groups remain visible. Search does not apply a relevance cutoff; if a | ||
| group is collapsed, matching rows remain available when that group is |
There was a problem hiding this comment.
[Minor] Distinguish project collapse from preview pagination
When a search matches more sessions in one project than the preview limit, the project is already open: isGroupCollapsed returns false while filtering (web/src/components/SessionList.tsx:1435–1436). getVisibleGroupSessions still applies the separate preview cap. Expanding the project header therefore cannot reveal the remaining matches; users must use the batch reveal control. This paragraph, together with the 'collapsed project' description on line 73, directs users toward the wrong control.
Suggested fix
Explain that search automatically opens matching project groups, but preview pagination still applies and additional matches are revealed through the batch controls. Describe the preview limit as applying within an open project group on line 73.
There was a problem hiding this comment.
Review mode: follow-up after new commits
Requirement — Pass
A dedicated guide helps users understand relevance-based search, session ordering, filters, and the different picker policies.
Evidence
- The snapshot PR description identifies confusion about relevance versus recency and differences between session pickers.
- web/src/lib/sessionListSearch.ts:211, web/src/lib/sharePickerSessions.ts:21, and web/src/lib/sessionReference.ts:68 implement distinct ordering policies, consistent with the related #1841/#1842/#1848 discussion.
Approach — Pass
Documenting existing behavior in one guide and linking it from relevant entry points is appropriate and introduces no runtime changes.
Evidence
- The full merge-base diff changes only docs/.vitepress/config.ts, docs/guide/pwa.md, docs/guide/session-list.md, and web/README.md.
- docs/guide/session-list.md:35 describes metadata matching and relevance without exposing scoring constants; lines 89–106 distinguish share-target and mention policies.
Code — Reviewed
Reviewed the entire fixed-head diff against the relevant implementation and linked contracts. No actionable defects found. The previous finding is resolved: the guide now distinguishes automatically opened groups from preview pagination and directs users to batch reveal controls.
No reportable code issues found.
Testing
Not run (automation; PR code execution is prohibited).
- Static content and local link-target inspection completed; git diff --check passed. No PR code, tests, builds, or scripts were executed.
- Observed CI: integration succeeded; test and windows-codex-mcp remained in progress.
- The snapshot reports successful typechecking and builds, plus 11 CLI test failures attributed by the author to existing platform/environment cases; downstream suites did not run. These local validation claims were not independently reproduced.
HAPI Bot
Summary
@-mention picker policies.Problem / Motivation
The Web session list has user-visible ordering and search behavior that was previously described mainly by source code and tests. This made it unclear why search results are not always ordered by date and how the main sidebar differs from the share-target and
@-mention pickers.This documentation-only change records the current behavior without changing runtime logic or exposing internal scoring constants.
Validation
bun typecheck— passed.bun run test:e2e -- terminal-wrap-fidelity.spec.ts— passed, 2/2.bun run build— passed; existing Vite/PWA warnings were emitted for unresolved KaTeX font references, missing manifesttheme_color, stale Browserslist data, and large chunks.cli/README.mdlink tohttp://localhost:3006was temporarily ignored for this check.git diff --check— passed.bun run test— 2,937 tests passed, 11 failed, and 9 skipped across the CLI run; the failures were unrelated existing Windows/platform-environment cases involving executable/PATH resolution, Windows shell quoting, file modes, and media URL handling. Becausetest:clifailed, the chained Hub/Web/Shared/Relay suites did not run.Related Issues
Refs #1841
Refs #1842
Refs #1848
AI Disclosure
OpenAI Codex (GPT-5.6) assisted with repository analysis and documentation drafting.