Make syntax reference guide keyboard shortcut hint clickable

[brendan-kellam]

Makes the the reference guide keyboard shortcut hints clickable

Fixes #228

Summary by CodeRabbit

• New Features
  • Introduced an interactive syntax reference guide that users can access via clickable hints.
  • Enhanced the search suggestions area by enabling direct activation of syntax help.
  • Updated the home screen by replacing keyboard shortcut hints with a more intuitive syntax guide prompt.

[coderabbitai]

Walkthrough

This pull request implements a context-based state management system for a syntax guide feature. It introduces a new provider and hook to handle the open state of the syntax guide. Multiple components—including the search suggestions box, syntax reference guide, and a new syntax guide hint—have been updated to use the context hook for triggering and reflecting state changes. Additionally, the layout and page components were modified to integrate the new provider and replace outdated keyboard shortcut hints.

Changes

File(s)	Change Summary
packages/web/src/app/components/[searchBar/searchSuggestionsBox.tsx, syntaxReferenceGuide.tsx, syntaxReferenceGuideHint.tsx]	Integrated the useSyntaxGuide hook: added an event handler in the search suggestions box, removed local state in the syntax reference guide (updating openDialog/closeDialog), and introduced the new SyntaxReferenceGuideHint component to trigger state changes.
packages/web/src/app/[layout.tsx, page.tsx]	Updated component hierarchy by adding the SyntaxGuideProvider; replaced KeyboardShortcutHint with SyntaxReferenceGuideHint in the page layout.
packages/web/src/app/syntaxGuideProvider.tsx	Introduced a new file that provides a context provider and the useSyntaxGuide hook for managing the syntax guide’s open state.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant C as Component (SearchSuggestionsBox / GuideHint)
    participant H as SyntaxGuide Hook
    participant P as SyntaxGuideProvider
    participant R as SyntaxReferenceGuide

    U->>C: Clicks syntax guide element
    C->>H: Calls onOpenChanged(true)
    H->>P: Updates isOpen state
    P->>R: Notifies state change
    R-->>U: Renders open/close dialog

Loading

Poem

Oh, I hopped through lines of code today,
Uncovering hooks along the way.
With context bright and state entwined,
My syntax guide is now refined.
Code carrots crunch with joyous glee! 🥕🐇

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

• We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
  - To enable this feature, set early_access to true under in the settings.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bf76cb9 and fb6ed44.

📒 Files selected for processing (6)

• packages/web/src/app/components/searchBar/searchSuggestionsBox.tsx (3 hunks)
• packages/web/src/app/components/syntaxReferenceGuide.tsx (1 hunks)
• packages/web/src/app/components/syntaxReferenceGuideHint.tsx (1 hunks)
• packages/web/src/app/layout.tsx (2 hunks)
• packages/web/src/app/page.tsx (2 hunks)
• packages/web/src/app/syntaxGuideProvider.tsx (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: build

🔇 Additional comments (15)

packages/web/src/app/components/syntaxReferenceGuideHint.tsx (1)

1-17: Clean implementation of the clickable syntax guide hint component.

This new component successfully implements a clickable reference guide hint that uses the context provider to manage state. The component structure is well-organized and follows React best practices with clear separation of concerns.

packages/web/src/app/page.tsx (2)

16-16: Appropriate import of the new SyntaxReferenceGuideHint component.

The import is correctly placed with other component imports.

---

106-106: Successfully replaced keyboard shortcuts with clickable component.

The SyntaxReferenceGuideHint component effectively replaces the previous keyboard shortcut hints, making the reference guide accessible via clicking as well as keyboard shortcuts.

packages/web/src/app/components/searchBar/searchSuggestionsBox.tsx (3)

20-20: Correct import of the syntax guide hook.

The useSyntaxGuide hook is properly imported for state management.

---

83-83: Proper hook usage for syntax guide state.

The hook is correctly initialized to access the context-provided state management function.

---

396-399: Enhanced UX by making the syntax help section clickable.

The div has been properly updated with cursor-pointer class and onClick handler to open the syntax guide, improving user experience by providing an additional way to access the reference guide.

packages/web/src/app/syntaxGuideProvider.tsx (3)

5-8: Well-defined context type with clear interface.

The SyntaxGuideContextType interface clearly defines the shape of the context with boolean state and update function.

---

12-18: Robust hook implementation with error handling.

The useSyntaxGuide hook properly checks for context availability and throws a helpful error message if used incorrectly.

---

20-32: Clean provider implementation using React best practices.

The SyntaxGuideProvider component follows best practices with useState for state management and useCallback for stable function references. The provider properly wraps children with the context value.

packages/web/src/app/layout.tsx (2)

10-10: Great addition of the SyntaxGuideProvider import.

This cleanly introduces the new context provider needed for the syntax guide state management.

---

39-48: Excellent component architecture.

The implementation of wrapping both the page content and the SyntaxReferenceGuide within the SyntaxGuideProvider creates a shared context that allows any component in the component tree to access and modify the syntax guide's state. This is a clean approach that follows React best practices for state sharing across components.

packages/web/src/app/components/syntaxReferenceGuide.tsx (4)

15-17: Good refactoring of imports.

The change from using local state management to context-based state management is correctly reflected in the imports. Removing useState and adding the useSyntaxGuide hook maintains clean dependencies.

---

23-23: Well-implemented state management transition.

The component successfully transitions from local state (useState) to context-based state management using the new useSyntaxGuide hook. This refactoring allows other components to control the syntax guide dialog's visibility.

---

26-29: Properly updated dialog open handler.

The openDialog function has been correctly updated to use the context-provided state handler instead of the local setState. Dependency array properly includes onOpenChanged.

---

31-39: Properly updated dialog close handler.

The closeDialog function has been correctly updated to use the context-provided state handler instead of the local setState. The focus handling for accessibility is preserved, which is excellent. Dependency array properly includes onOpenChanged.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.