QUA-1588: Document Team Restriction Mode and refresh Top Right Side Menu surfaces#1113
QUA-1588: Document Team Restriction Mode and refresh Top Right Side Menu surfaces#1113RafaelOsiro wants to merge 7 commits into
Conversation
Update the Web Application overview and the Top Right Side Menu Getting Started page so each menu item description matches its new dedicated page and the card icons reflect the labels used in the product.
…Updates with how-to steps Replace the single-screenshot pages for each top-right-menu surface with a walkthrough that covers what each menu item does and the steps to use it, including the dark/light/system theme toggle, the card/list view switch, the Product Updates panel, and the Discover resource categories.
…d API pages Replace the single In-App Notifications page with a dedicated section that covers the notification panel, the navigation, mark-as-read and bulk mark-as-read flows, the API endpoints for listing and acknowledging notifications, and a FAQ. The mkdocs nav is updated to expose the new sub-pages under Top Right Side Menu.
… Profile section Add the Team Restriction Mode page covering when the badge is available (multi-team accounts), how the click flow works, the role downgrade to Manager while restricted, Internal-role exemption, and the limitations that apply only to the current browser session. Split the User Profile entry into Introduction, Profile, and Team Restriction pages and link from the Team Permissions reference so admins can find the preview flow from the Settings area.
… duplication Drop the Ctrl/Cmd + Shift + F shortcut (no binding exists in the codebase; asset results already surface in the same palette as you type), fix the macOS delete shortcut from Cmd + Del to Cmd + Backspace to match the DELETE_KEY constant, and add the missing Agent Q entries (G then Q to navigate and Q to toggle the chat). Trim the intro that duplicated the Command Palette page, drop the redundant categories TOC table, explain the two-key sequence behavior once at the top, and add a short context line per category table so readers know where each shortcut is active.
RafaelOsiro
requested review from
Hitsu-360,
ets,
gasscoelho,
josecsotomorales and
pelegolas9
…tion-mode # Conflicts: # docs/settings/security/team-permissions.md
Apply :material-X: icons in brick color to all H1s in the Web Application section, using each feature's MDI icon from the frontend. API/FAQ pages use the standard card icons (api, help-circle-outline). Navigation pages adopt the compass icon as the new standard. Refactor view-mode and theme step lists into tab groups: each transition is one step showing the button click followed by the resulting page. Replace mermaid icon shortcodes with plain text labels since they do not render inside mermaid blocks. Tighten the Global Search getting-started intro.
Greptile SummaryThis PR documents the new Team Restriction Mode feature, splits the flat In-App Notifications and User Profile pages into dedicated sub-trees, and refreshes the surrounding Top Right Side Menu walkthroughs with step-by-step screenshots. It also corrects three factual errors in Keyboard Shortcuts (removed the non-existent
Confidence Score: 3/5The documentation content is accurate and well-structured, but two broken-link issues introduced by this PR should be resolved before merging. Two flat pages were deleted and replaced by sub-directory trees without adding redirect_maps entries, so the old published URLs will 404 immediately after deploy. Additionally, command-palette.md still tells users to look up Asset Search in Keyboard Shortcuts — a shortcut this PR removed. Both issues affect content that readers will actively follow. mkdocs.yml (missing redirect entries for the two deleted flat pages) and docs/using-the-platform/web-app/global-search/command-palette.md (stale Asset Search note). Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
subgraph OLD["Before this PR"]
A["in-app-notifications.md flat"]
B["user-profile.md flat"]
end
subgraph NEW["After this PR"]
subgraph IAN["In-App Notifications sub-tree"]
C["introduction.md"]
D["how-tos/navigate.md"]
E["how-tos/mark-as-read.md"]
F["how-tos/bulk-mark-as-read.md"]
G["faq.md"]
H["api.md"]
end
subgraph UP["User Profile sub-tree"]
I["introduction.md"]
J["profile.md"]
K["team-restriction.md NEW"]
end
end
A -- "deleted, no redirect" --> C
B -- "deleted, no redirect" --> I
|
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| - App Navigation: using-the-platform/web-app/app-navigation.md | ||
| - Top Right Side Menu: | ||
| - Getting Started: using-the-platform/web-app/top-right-menu/getting-started.md | ||
| - In-App Notifications: using-the-platform/web-app/top-right-menu/in-app-notifications.md | ||
| - In-App Notifications: | ||
| - Introduction: using-the-platform/web-app/top-right-menu/in-app-notifications/introduction.md | ||
| - How-tos: | ||
| - Navigate: using-the-platform/web-app/top-right-menu/in-app-notifications/how-tos/navigate.md | ||
| - Mark as Read: using-the-platform/web-app/top-right-menu/in-app-notifications/how-tos/mark-as-read.md | ||
| - Bulk Mark as Read: using-the-platform/web-app/top-right-menu/in-app-notifications/how-tos/bulk-mark-as-read.md | ||
| - FAQ: using-the-platform/web-app/top-right-menu/in-app-notifications/faq.md | ||
| - API: using-the-platform/web-app/top-right-menu/in-app-notifications/api.md | ||
| - Discover: using-the-platform/web-app/top-right-menu/discover.md | ||
| - Theme: using-the-platform/web-app/top-right-menu/theme.md | ||
| - View Mode: using-the-platform/web-app/top-right-menu/view-mode.md | ||
| - Product Updates: using-the-platform/web-app/top-right-menu/product-updates.md | ||
| - User Profile: using-the-platform/web-app/top-right-menu/user-profile.md | ||
| - User Profile: | ||
| - Introduction: using-the-platform/web-app/top-right-menu/user-profile/introduction.md | ||
| - Profile: using-the-platform/web-app/top-right-menu/user-profile/profile.md | ||
| - Team Restriction: using-the-platform/web-app/top-right-menu/user-profile/team-restriction.md | ||
| - Global Search: |
There was a problem hiding this comment.
Both in-app-notifications.md and user-profile.md have been deleted and replaced by sub-directory trees, but no redirect_maps entries were added for the old URLs. Any external link, search-engine result, or bookmark pointing to .../top-right-menu/in-app-notifications or .../top-right-menu/user-profile will now return a 404. Every previous restructure in this repo has followed the pattern of adding an entry to the redirect_maps block — e.g., 'anomalies/anomalies.md': 'anomalies/overview.md' and dozens of others. Two entries are needed:
'using-the-platform/web-app/top-right-menu/in-app-notifications.md': 'using-the-platform/web-app/top-right-menu/in-app-notifications/introduction.md''using-the-platform/web-app/top-right-menu/user-profile.md': 'using-the-platform/web-app/top-right-menu/user-profile/introduction.md'
1 participant
Overview
This PR documents the new Team Restriction Mode badge that lets multi-team users (Admins included) scope the entire web session to a single team, refreshes the surrounding Top Right Side Menu pages so each item has a dedicated walkthrough, and applies a new H1 icon pattern across the whole Web Application section. It also corrects three factual errors on the Keyboard Shortcuts reference that were caught during the review pass.
Key Changes
allTeams.length > 1in the frontend)Introduction+Profile+Team Restrictionso each concern lives on its own pageIntroduction+How-tos(Navigate, Mark as Read, Bulk Mark as Read) +FAQ+API# :material-X:{ .middle style="color: var(--q-brick)" } Title) sourced from the frontend component for that feature; API/FAQ/Navigation pages use the standard card icons; mermaid icon shortcodes were replaced with plain text labels since they don't render inside mermaid blocksCtrl/⌘ + Shift + F(no such binding exists in the frontend; asset results already surface in the same palette as you type)⌘ + Del→⌘ + Backspace(matchesDELETE_KEYconstant)G then Q(Go to Agent Q) andQ(Toggle Agent Q chat)Pages to Review
Heads-up
#themeno longer exists; the new slug includes the icon shortcode text). H1 anchors are rarely linked externally — the page URL itself opens at the top — but worth knowing.Out of Scope