rune
76b58e6fdc
"oAI" reads as easily confused with OpenAI, both visually and in casual conversation. Renamed to "Confab" throughout: Xcode target/scheme/bundle ID (com.oai.Confab), Info.plist and Help Book identity, all user-facing UI text, internal Log subsystem and color identifiers, localization catalogs (6 languages, including a proper reworded/retranslated Intel-deprecation notice), Help Book HTML content, and docs (README/DEVELOPMENT/PRIVACY/SECURITY). Deliberately cosmetic-only: the on-disk data folder (~/Library/Application Support/oAI/), database/backup filenames, Keychain service identifiers, and EncryptionService's key-derivation inputs are all left untouched so existing conversations, settings, and stored API keys survive the update with zero migration and no re-entering credentials. Verified live: a real signed build successfully decrypted a stored API key and loaded an existing conversation database after the bundle ID change. Also includes a small already-completed, previously uncommitted model-release-date feature (ModelInfo/OpenRouterModels/ OpenRouterProvider/ModelInfoView) that happened to share several files with this rename. Gitignored on this branch and updated on disk but not part of this commit: CLAUDE.md, RELEASE_NOTES.md, and the build*.sh scripts.
72 lines
2.1 KiB
Markdown
72 lines
2.1 KiB
Markdown
# Confab Help Book
|
|
|
|
This folder contains the Apple Help Book for Confab.
|
|
|
|
## 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 'Confab'..."
|
|
- Select the `Confab.help` folder
|
|
- **Important:** Check "Create folder references" (NOT "Create groups")
|
|
- Click "Add"
|
|
|
|
2. **Configure the help book in build settings:**
|
|
- Select your Confab target in Xcode
|
|
- Go to the "Info" tab
|
|
- Add a new key: `CFBundleHelpBookName` with value: `Confab Help`
|
|
- Add another key: `CFBundleHelpBookFolder` with value: `Confab.help`
|
|
|
|
3. **Build and test:**
|
|
- Build the app (⌘B)
|
|
- Run the app (⌘R)
|
|
- Press ⌘? or select Help → Confab Help to open the help
|
|
|
|
## Structure
|
|
|
|
```
|
|
Confab.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 Confab 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:
|
|
```html
|
|
<meta name="AppleTitle" content="Page Title">
|
|
<meta name="keywords" content="keyword1, keyword2">
|
|
```
|