Files
oai-swift/oAI/Resources/oAI.help
rune 86027001c7 Roll back native Help Viewer integration; fix duplicate View menu
Per Rune: the NSHelpManager-based Cmd+? fix from the last few commits
technically worked (registration was correct) but opened Apple's
broken generic Tips landing page instead of oAI's own content on the
macOS 27 beta this is built against — worse than the original
browser-tab behavior. Revisit at macOS 27 RC1 (see CLAUDE.md).

- openHelp() reverts to NSWorkspace.open() on index.html directly.
- Removed the "In-App Help" Ctrl+Cmd+H menu item entirely — HelpView's
  panel (search already fully working) is reachable only via /help
  from the input field now, by design.
- Renamed the custom CommandMenu("View") to CommandMenu("Chat") — it
  was colliding with the "View" menu macOS auto-adds for
  NavigationSplitView (Enter Full Screen, etc.), producing two
  identically-titled top-level menus in the menu bar.
2026-07-20 08:17:33 +02:00
..

oAI Help Book

This folder contains the Apple Help Book for oAI.

Adding to Xcode Project

  1. Add the help folder to your project:

    • In Xcode, right-click on the Resources folder in the Project Navigator
    • Select "Add Files to 'oAI'..."
    • Select the oAI.help folder
    • Important: Check "Create folder references" (NOT "Create groups")
    • Click "Add"
  2. Configure the help book in build settings:

    • Select your oAI target in Xcode
    • Go to the "Info" tab
    • Add a new key: CFBundleHelpBookName with value: oAI Help
    • Add another key: CFBundleHelpBookFolder with value: oAI.help
  3. Build and test:

    • Build the app (⌘B)
    • Run the app (⌘R)
    • Press ⌘? or select Help → oAI Help to open the help

Structure

oAI.help/
├── Contents/
│   ├── Info.plist              # Help book metadata
│   └── Resources/
│       └── en.lproj/
│           ├── index.html      # Main help page
│           └── styles.css      # Stylesheet
└── README.md                   # This file

Features

  • Comprehensive coverage of all oAI features
  • Searchable via macOS Help menu search
  • Dark mode support
  • Organized by topic with table of contents
  • Keyboard shortcuts reference
  • Command reference with examples
  • Follows Apple Human Interface Guidelines

Customization

To update the help content:

  1. Edit Contents/Resources/en.lproj/index.html
  2. Update styles in Contents/Resources/en.lproj/styles.css
  3. Rebuild the app

Troubleshooting

If help doesn't open:

  • Make sure you added the folder as a "folder reference" (blue folder icon in Xcode)
  • Check that CFBundleHelpBookName and CFBundleHelpBookFolder are set in Info
  • Clean build folder (⇧⌘K) and rebuild

Adding More Pages

To add additional help pages:

  1. Create new HTML files in Contents/Resources/en.lproj/
  2. Link to them from index.html
  3. Include proper meta tags for searchability:
    <meta name="AppleTitle" content="Page Title">
    <meta name="keywords" content="keyword1, keyword2">