search

nikitabobko / AeroSpace

AeroSpace is an i3-like tiling window manager for macOS
https://nikitabobko.github.io/AeroSpace/guide
MIT License
5.62k stars 88 forks source link

Add documentation for the menu bar #439

Open DjebbZ opened 3 weeks ago

DjebbZ commented 3 weeks ago

Hello,

The AeroSpace documentation is quite exhaustive regarding the installation and configuration, but doesn't mention at all anything related to the menu bar.

I'm creating this issue because after some (?) manipulation I noticed a [s] appeared, no idea how and what it is.

As I don't know this menu bar nor Swift I can't dig in and write the docs myself, but I'm gently asking for documenation about everything related to the menu bar.

Happy to help reviewing/writing it if possible.

Checklist

~ aerospace --version
aerospace CLI client version: 0.12.0-Beta 9cf82feb0c85bea77fedcdc6b8cdba75b5bbf1f8
AeroSpace.app server version: 0.12.0-Beta 9cf82feb0c85bea77fedcdc6b8cdba75b5bbf1f8
graywolf-s1 commented 3 weeks ago

I'm creating this issue because after some (?) manipulation I noticed a [s] appeared, no idea how and what it is.

I am pretty sure you managed to switch into the https://github.com/nikitabobko/AeroSpace/blob/main/docs/config-examples/default-config.toml#L187 service mode binding.

DjebbZ commented 3 weeks ago

You mean, when one switches to a mode other than main, the first letter appears in square brackets?

If so, this is exactly the kind of behavior that needs documentation.

On Wed, Aug 21, 2024, 13:50 graywolf-s1 @.***> wrote:

I'm creating this issue because after some (?) manipulation I noticed a [s] appeared, no idea how and what it is.

I am pretty sure you managed to switch into the https://github.com/nikitabobko/AeroSpace/blob/main/docs/config-examples/default-config.toml#L187 service mode binding.

— Reply to this email directly, view it on GitHub https://github.com/nikitabobko/AeroSpace/issues/439#issuecomment-2301860070, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAS3XSMDC4BBM4PNHA7R4DZSR5GVAVCNFSM6AAAAABM3P7MNOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGMBRHA3DAMBXGA . You are receiving this because you authored the thread.Message ID: @.***>

danfbfern commented 3 weeks ago

You mean, when one switches to a mode other than main, the first letter appears in square brackets? If so, this is exactly the kind of behavior that needs documentation.

That is precisely the case, but its not documented like you said. On this note, I would even prefer to see an option to show the full mode name instead of just the first letter or even more customisation regarding the menubar and remove the need of sketchybar to show information about opened workspaces for example.

Grezzo commented 3 weeks ago

this is exactly the kind of behavior that needs documentation

You don't need to be a developer to contribute to the docs. Fork the repo, create a branch, update the docs (e.g. at docs/guide.adoc in the repo) then issue a pull request.

The dev has clearly put a lot of time into this project and released it for us to use at no cost. From doing some dev work myself I know that writing docs is the least fun and motivating part of the work. The docs are good but are not perfect, as you've pointed out. If you have the time but not the dev skills to fix bugs or make other enhancements then it would be great if you could contribute to the project by adding whatever you see as missing in the docs :-)

DjebbZ commented 2 weeks ago

Ok, I may try adding docs for the menubar item some time this week (hopefully).

Leaving the issue opened for my (hopefully) upcoming PR.