DottaandPaperclip
a61cf38106
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - The feature map describes product capabilities and user journeys. > - Small fixes and test changes have added long notes to that map. > - These notes make substantial features harder to find. > - This pull request removes those additions from the last week's changes and sets a clear rule for future additions. > - The benefit is a smaller map with stable capability IDs and accurate entry points. ## Linked Issues or Issue Description **Issue type** Unclear or confusing documentation. **Where is the issue?** `maps/feature-map/`, the map maintenance instructions, and repository rules. **What's wrong?** Between October 27 and November 3, 2026, 115 commits changed the feature map. Many additions describe bug fixes, performance details, small UI changes, or new tests. They do not introduce substantial product features. The old synchronization instructions also encouraged a map edit for every behavior change. **Suggested fix** Add a rule that requires a substantial new feature before expanding the map. Remove minor-update notes. Keep genuine feature additions and minimal corrections to existing instructions. The review covers master through `b22ef22d56`; it does not revert application code. Conflict resolution preserves later map changes from master outside that audit snapshot. Searched open GitHub PRs and issues for related feature-map work. No duplicate cleanup was found. Substantial feature additions retained here include Coordinator (#17983), the agent YAML editor (#18036), document image galleries (#18157), remote workspace storage (#18403), native Kimi (#18391), proactive chat messages (#18374), and the Sentry receiver added in #18714. ## What Changed - Add `rules/feature-map-scope.mdc` and register its `maps/**` scope with Greptile. - Align `AGENTS.md` and the shared map contract with that rule. Routine fixes and test changes no longer require incidental map edits. - Remove 755 net lines from 23 feature recipes. Preserve all 35 areas and 192 capability IDs. - Keep substantial features and the corrections needed for current navigation, provider availability, and access boundaries. Examples from the reviewed changes: | Removed or shortened addition | Why it does not need a feature-map expansion | | --- | --- | | Rounded composer image thumbnails (#18689) | Small UI change within existing task creation. | | Connection profile reads and review-count queries (#18687, #18688) | Performance details within existing app permissions. | | Warm-session, Retry, export-capacity, and tool-wait cases | Regression details for existing execution and recovery. | | New task-search, project-context, document-persistence, and routine test journeys | Test additions for existing capabilities. The tests remain in place. | | New task button placement (#18703) | Another entry to an existing task form. | | Local browser verification notes | Run evidence belongs in the PR or test report. | ## Verification - `node scripts/check-maps.mjs` passes: 35 areas, 192 capability IDs, valid references and contract fields. - `node scripts/storybook-catalog.mjs` passes: 328 files and 3,068 stories. Generated indexes remain ignored. - Compared capability keys and navigation metadata in every edited recipe with the original source. All are unchanged. - Checked rule frontmatter, Greptile registration, representative scope matches, and `git diff --check`. - `pnpm -r typecheck` and `pnpm build` pass on `9a60eef8eb8da9bc7c3a02203c79bec12e8c8b6b`. The final `a0801e8a939494ecde3739097a80258917428e94` commit only corrects two lines in the plugin-panel recipe; map and catalog checks pass again. - Greptile reviewed the final `a0801e8a939494ecde3739097a80258917428e94` head at 5/5 with no findings. The earlier review found one inaccurate phrase about unavailable plugin panels. The hook confirms that readiness gates automatic opening, while declared panels remain selectable. The final documentation commit corrects that phrase and the thread is resolved. Paperclip's refreshed review is advisory and remains queued. - The earlier CI run failed two assertions: [server 4/12](https://github.com/paperclipai/paperclip/actions/runs/41634761842/job/125914173960) counted three Anthropic identity calls instead of two in `connection-management.integration.test.ts`; [chat 1/3](https://github.com/paperclipai/paperclip/actions/runs/41634761842/job/125914174257) observed zero publications instead of one in the same-principal endpoint-settlement case. Both exact tests pass locally on the rebased head. This PR changes neither their source nor their expectations. These failed results remain historical evidence. - Final-head CI passed server 4/12 and all other suites except the first [chat 1/3 attempt](https://github.com/paperclipai/paperclip/actions/runs/41637834618/job/125925926131), which repeated the same zero-publication assertion. The browser gate passed. The single failed-job retry was accepted for this unchanged head in [workflow attempt 2](https://github.com/paperclipai/paperclip/actions/runs/41637834618/attempts/2). [Chat 1/3 passed on that retry](https://github.com/paperclipai/paperclip/actions/runs/41637834618/job/125933199635), and the aggregate verification gate passed. Both required gates, `ci / verify` and `ci / e2e`, are green on `a0801e8a939494ecde3739097a80258917428e94`. The one retry allowance is consumed. - The first full local `pnpm test:run` attempt was interrupted before completion so master could be rebased without changing source under running tests. It is not a passing test result. Full current-head CI remains required. - No application code, tests, schemas, or lockfiles changed. ## Risks - Low runtime risk. This change only edits documentation and review guidance. - Detailed regression instructions become less visible in the feature map. Their tests and technical documentation remain available. - Some additions mix a new feature with a small fix. Those blocks retain the feature and shorten the incidental detail. ## Model Used - OpenAI Codex, GPT-6 family, with reasoning, Git history inspection, repository tools, and code execution. The session does not expose a more specific model deployment ID or context-window size. ## Checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used (with version and capability details) - [x] I have checked ROADMAP.md and confirmed this PR does not duplicate planned core work - [x] I have searched GitHub for duplicate or related PRs and linked them above - [x] I have either (a) linked existing issues with `Fixes: #` / `Closes #` / `Refs #` OR (b) described the issue in-PR following the relevant issue template - [x] I have not referenced internal/instance-local Paperclip issues or links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip` URLs) - [x] My branch name describes the change (e.g. `docs/...`, `fix/...`) and contains no internal Paperclip ticket id or instance-derived details - [x] I have run tests locally and they pass — map, catalog, capability-ID, and rule-scope checks; full Vitest limits are stated above - [x] I have added or updated tests where applicable — no new runtime tests apply to this documentation change - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] All Paperclip CI gates are green - [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
9.9 KiB
navigation
| navigation | ||||||
|---|---|---|---|---|---|---|
|
Navigation, profile, and announcements
People organize their sidebar, move between company resources, maintain their profile, and dismiss product announcements with the correct persistence and identity scope.
Feature ID: navigation-preferences.
Implementation: sidebar, profile, announcements.
Agent access: companion.
Sub-features
navigation:navigation-preferences/navigation— use current sidebar links, favorites, recents, and available layout controls.preferences:navigation-preferences/preferences— persist supported ordering/collapse choices for the intended user/company, and the personal experimental workspace choice.profile:navigation-preferences/profile— edit personal identity and inspect public profile links.announcements:navigation-preferences/announcements— inspect and dismiss an announcement with its intended instance-wide user scope.fallbacks:navigation-preferences/fallbacks— handle missing resources and old deep links without presenting another resource as the target.command-palette:navigation-preferences/command-palette— open quick search and creation actions with keyboard shortcuts, then carry query/filter intent into full search.
How to get to it (user POV)
sidebar-deep-links
Use starred/recent/sidebar links and direct company-prefixed URLs.
profile-announcements
Use Settings → Profile, /u/:userSlug, and the announcement well when a publication is available.
palette-shortcuts
Press Cmd/Ctrl+K to open the command palette. / focuses the current page search or opens quick search; ? opens shortcut help. Outside an input or modal, c starts New task and g then i opens Inbox/My work. In the palette, use Search all or Cmd/Ctrl+Enter for the full results page.
Driving it with Playwright and the Paperclip CLI
Preconditions: follow the baseline. Use two test users and companies; record the selected UI shell and any client-local preference storage.
sidebar-deep-links
Automated: sidebar and sidebar preference routes cover UI/server behavior.
Manual: Star and reorder supported resources, collapse a section, navigate and reload. Switch company/user and inspect the intended preference scope. Open an unavailable resource and a legacy route; verify clear fallback or correct redirect without leaking another company’s state.
Record persistence separately: section collapse is in-memory and reopens after reload; global sidebar collapse is disabled. Streamlined starred projects sort alphabetically. Recents are browser-local by user/company; stars and supported ordering are saved server-side. Local-trusted mode does not prove two-user isolation.
profile-announcements
Automated: profile page, announcement hook, and announcement routes cover separate UI/persistence layers.
Manual: Change a disposable user’s display details, reload, and inspect an attributed profile link. Dismiss a fixture announcement, switch companies, and verify it remains dismissed for that user; check another user still has their own dismissal state.
palette-shortcuts
Automated: Command palette, shortcut hook, shortcut rules, and cheatsheet test components and keyboard rules. Company search covers search contracts; browser focus and identity transitions still need a live check.
Manual: Use uniquely named visible and private task/project fixtures. Open the palette, find a permitted result, follow it, and reload the destination. Enter text with quick-filter chips such as assignee:me, is:open, and updated:>7d; use Search all and Cmd/Ctrl+Enter in separate attempts and verify the resulting query and filters. Switch person/company and confirm private results do not leak. Test / on a page with search and a page without it; inspect ?, c, and g i. Type those keys inside an editor and a modal: they must not unexpectedly navigate or create work. Test a create action through its normal dialog and inspect the actual saved resource separately.
Sources: Command palette, shortcut hook, query parser, and search routes.
Gotchas
-
Cmd/Ctrl+B is not a supported global sidebar shortcut. Use the current shortcut help and verify that typing and modal focus suppress navigation chords.
-
Announcement dismissals are intentionally instance-wide user preferences, unlike company-scoped domain data.
-
Legacy/production shells need their own navigation check when affected.
-
A route redirect is part of the journey; do not document a removed screen as if it still renders.
Storybook verification
preferences
Capability ID: navigation-preferences/preferences.
Scope: ui Storybook: Mount Sidebar using real preference boundary with stars/order/collapse/recents state. Clearly distinguish in-memory section collapse, browser-local recents and server-saved stars/order. Production: GET/PUT /sidebar-preferences/me and /companies/{id}/sidebar-preferences/me plus stars must retain intended user/company isolation across reload and switch. Section collapse reopens after reload; global collapse is disabled. Sources: Source: Sidebar.tsx, sidebar-preferences.ts, sidebar-preferences.ts. Tests: Sidebar.test.tsx, sidebar-preferences-routes.test.ts
fallbacks
Capability ID: navigation-preferences/fallbacks.
Scope: browser Storybook: A NotFound rendering story can help polish, but missing-resource/legacy-deep-link capability principally needs real App/router/browser scenarios preserving company and query intent. Production: Cold-open invalid company/resource and retired URL; verify explicit fallback or correct canonical redirect without silently targeting a different resource/company. Sources: Source: NotFound.tsx, App.tsx, company-routes.ts. Tests: App.activity-routing.test.tsx, App.cases-routing.test.tsx, App.test.tsx, company-routes.test.ts
Recent task refresh performance
Saved recent tasks render immediately. One summary batch refreshes at most five IDs per company/account without passive full-detail or workspace inspection. Successful omissions remove unavailable entries; failed reads preserve history. Verify rename, inbox archive, pause/restart, reload, cross-tab updates and account switches. Inbox archive does not remove the task from recent history.
Personal Coordinator workspace
Settings → Experimental → Coordinator workspace opts the current person into the experimental shell; off restores classic. The server saves the choice by user across companies, separate from instance feature flags. The local-trusted identity is shared Local Board, not evidence of multi-user isolation. Agent Chat remains an independent instance prerequisite. When it is off, the personal card explains the dependency and links eligible instance administrators to the existing Agent Chat control. Hidden or Cloud-managed controls are not presented as editable. Disabled Chat routes link back to Experimental settings. Enabling the personal workspace never changes the instance capability.
Automated: preference hook, prerequisite settings card, authorization, and database persistence. Manual: toggle on/off, reload, switch companies/accounts, and simulate failed reads and saves. Confirm existing work is unchanged and a failed save keeps the current choice. The Settings card story uses the production component with simulated API responses; it does not establish real persistence or permission behavior.
Coordinator More exposes a pin/unpin button beside every destination. Pinned pages appear beneath More in pinning order and retain the existing company-aware routes. Unpin from either the flyout or the pinned row. The list is personal to the current user in this browser, shared across companies; it does not sync across devices. Only known route names are rendered. Storage failures show a save error. The pin hook owns browser persistence; sidebar tests cover pin/unpin, remount persistence, account separation, unknown routes and cross-tab updates. Manual: pin with mouse and keyboard, reload, follow a pinned link, unpin from both locations, and check the mobile drawer. Local-trusted checks do not prove two-user authenticated browser isolation.