Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

✨ Add macOS Help Book Integration

Open
#2,134 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
macos, swift

Research direction

No source file, test, or entry point is identified in the issue. Start by reviewing CodeEdit’s macOS app packaging and Apple Help Book requirements, including Help Viewer integration, localization, and hiutil indexing. Define completion as a packaged Help Book that opens in Help Viewer and supports the requested search and localization behavior.

Written by the indexing model from the issue text.

Description

enhancement
Description

Add native macOS Help Book integration to CodeEdit.
Currently, CodeEdit does not provide built-in documentation or Help Viewer integration.
Adding a Help Book (.help bundle) would allow users to access offline help content via the system Help Viewer, just like Apple's own apps.

Alternatives Considered

No response

Additional Context

Modern macOS apps like Xcode and Finder still use Help Books for user documentation.
It also supports localization and indexing (hiutil) for search.

Would be great to integrate this in a future release.

Screenshots
Image

like this

Image
Dominant language
Swift
Stars
23k
Forks
1.2k
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from CodeEditApp/CodeEdit

All issues in CodeEditApp/CodeEdit

Similar issues

More Swift issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.