Ice icon indicating copy to clipboard operation
Ice copied to clipboard

[Feature Request]: Usage Guide

Open jordanbaird opened this issue 1 year ago • 4 comments

Description

We need a good usage guide that describes in detail how to use the core features of the app. I'm thinking we'd attach it using GitHub Pages, but I'm open to other options, too.

Screenshots

No response

jordanbaird avatar Jun 17 '24 17:06 jordanbaird

I'd be willing to contribute to the guide, I'm coming from a background of being an Apple Certified Trainer. I've put together several Keynote presentations for classes I've taught as well as some other documentation. My biggest roadblock seems to be even with the beta, I've lost the Ice Bar icon in my menubar. The beta is an incredible step up so thanks for that. I could try some documentation from my 2020 MBA M1 which does not have the notch (which seemingly is the biggest hurdle for Ice Bar.)

dreh65 avatar Jun 17 '24 17:06 dreh65

I'd be happy to proof read any documentation. I've spent a large part of my life in the print industry so reckon I'm pretty good at it and have the time as I'm retired. I'm in UK so there may be slight delays, but nothing major.

TimLawson avatar Jun 21 '24 15:06 TimLawson

I appreciate the responses!

@dreh65 There's a decent chance the Ice icon somehow got put into either the hidden or always-hidden section. If you have the show-on-click feature enabled, Option+click an empty space in the menu bar to show all sections (if not, dragging any icon should have the same effect). Then, Command+drag the Ice icon back into the visible section.

@TimLawson I'm happy to wait, especially if it means a higher quality end result. I'll reach out once we have an initial draft to work with.

jordanbaird avatar Jun 21 '24 17:06 jordanbaird

I have an idea. I'm one of the developers working on the secure password generator project XKPasswd. I just wrote our documentation using Docsify which is a static site generator, and publish easily as a GitHub page. Here's what they look like:

https://podfeet.github.io/docsify-user-docs-xkpasswd/

I also wrote up how I made these docs with Docsify and why I chose that tool over others.

https://www.podfeet.com/blog/2024/04/docsify-xkpasswd/

I'd love to help do this but I'm about to go on vacation. If someone else doesn't take the reigns before I get back in 2 weeks, I could take a shot at it and then have the others here work on editing what I write. Ping me so I remember I promised this!

podfeet avatar Jun 21 '24 18:06 podfeet