Description

Context

The goal of this proposal is to improve the Discoverability and Learnability of XWiki by centralizing all help resources and providing a modern, searchable interface for keyboard shortcuts.

Currently, help resources are scattered across different menus, and shortcuts are not easily accessible, making the learning curve steeper for new users.

Proposed Changes

Centralized Help Section

After community debate, the decision is to place the Help Section inside the Drawer.

• Key Features:

  • Direct links to Documentation, Community Forum, and Release Notes.
  • Integration with the Guided Tour App for onboarding.
  • Quick access to the new proposed Keyboard Shortcuts Modal.

Keyboard Shortcuts Modal

An interactive modal to display all available commands:

• The modal can be invoked from anywhere. Suggestions: Alt + ? / Ctrl + ?
• The modal dialog should contain an introductory text pointing to the full user documentation, opening in a new tab.
• The modal should also have a text pointing to the user preference on keyboard shortcuts. At the time of writing this, the PR was still not merged.
• The search functionality would be a simple, real-time JavaScript filter, like the one on this page.
• Shortcuts for the rich text editor will be visible to provide a consistent editing experience.
• A link to the "User Profile > Shortcuts" page, allowing users to customize their mappings.
• The “command - shortcut” order would be inverted compared to the user guide, following the user logic: “I want to do something; what is the shortcut?”
• The shortcut list should ideally be populated dynamically to allow extensions to register their own shortcuts.
• The only available action in the dialog, aside from searching, would be closing this dialog.

Design Mockups

Help Section in Drawer

Keyboard Shortcuts Modal