Cork icon indicating copy to clipboard operation
Cork copied to clipboard

Menubar item: Cork Help

Open Jerry23011 opened this issue 1 year ago • 7 comments

Problem

Currently, Cork's Help menubar item is not implemented, so whenever the user tries to open it, macOS will say that Cork Help is not available. 截屏2023-05-17 20 11 50 截屏2023-05-17 20 12 01

Proposed solution

There are three items that can potentially be implemented in Help

  1. Move Feedback from Cork dropdown menu to Help
  2. Cork's GitHub repo
  3. Cork's website

Jerry23011 avatar May 17 '23 12:05 Jerry23011

Apologies for getting back to you so late 😅

The Feedback idea is good, I'll move it. I wanted to implement Help, but it's very hard to find any info on how to actually do it. I'll look into it and write something up ,it could be useful 😊

The repo is already accessible from the "About" window, so I think it should stay there. As for the website, that also could be added to the "About" window, I think it would fit better in there.

buresdv avatar May 22 '23 08:05 buresdv

I noticed it, too. You can't implement it with SwiftUI

Jerry23011 avatar May 22 '23 10:05 Jerry23011

I wanted to implement Help, but it's very hard to find any info on how to actually do it. I'll look into it and write something up ,it could be useful 😊

Apple Help is a disaster. Here's what I learned while working on another project:

What's actually required to make a help page?

Here's a good step-by-step tutorial, and here is where I finally got search to work.

Why is the Help page just blank?

Apparently helpd only observes a few directories to update its index, and Xcode build output directories aren't included. Copy the binary to /Applications.

sh95014 avatar Aug 19 '23 20:08 sh95014

Apple Help is a disaster.

Can't agree more

@buresdv actually found another tutorial and we tried implementing it last night with no success.

Here's a good step-by-step tutorial, and here is where I finally got search to work.

Let me try this later, thank you 🙏🏻

Jerry23011 avatar Aug 20 '23 03:08 Jerry23011

I don't know how far you got, but I've submitted a PR that adds the working skeleton of a help book:

截圖 2023-08-21 上午11 35 17

Please note that I did not add Mario Guzman's hiutil build script to the project. That would certainly be a good idea to add if the PR is accepted.

sh95014 avatar Aug 21 '23 18:08 sh95014

Sorry about not giving you the latest updates, @sh95014. The help book is preliminarily implemented in the branch help-book.

Thank you so much for your article; a combination of the two articles made it work, and I also implemented hiutil

Jerry23011 avatar Aug 22 '23 01:08 Jerry23011

No worries, I've closed my PR then.

sh95014 avatar Aug 22 '23 08:08 sh95014