asmvik / asmvik/skhd

want some documentation clarification

Open
#259 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
C
Stars
8.1k
Forks
241
PR merge metrics
No merged PRs in 30d

Description

wondering what a use case is for the `->` symbol, don't see an example, and haven't found an example config that uses it

I think you should specify that `` should be the name of an application; in the example you see a use case but it is not directly inferrable from the documentation

specify that `|` means 'or you can do this', on first glance it looks like it might be some kind of pipe

sorry for the noobish questions, can do a PR to expand the documentation if we have a disussion and you think I have the right idea

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the documentation examples and configuration syntax referenced in the issue, especially the `->`, ``, and `|` notation. Done means adding a use case or example configuration and explicitly explaining that `` names an application and that `|` means an alternative.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.