Commit Graph
31 Commits
Author SHA1 Message Date
Guido Günther 97ed5a2bdd event-naming-spec: Copy-edit
Gbp-Dch: Ignore
2024-10-02 14:48:01 +02:00
Guido Günther ec843deb13 event-naming-spec: Fix section description 2024-10-02 14:48:01 +02:00
Guido Günther dc12f3016f theme: Add events for cellbroadcast 2024-09-23 12:18:26 +00:00
Guido Günther 6f03552249 doc: Document gsettings used by feedbackd 2024-08-30 12:19:31 +02:00
Guido Günther a4c35a8e61 led: Parse color values and pass them down the chain
We parse RGB color values as HEX ('#RRGGBB') and use those when a RGB
LED is available. Single color LEDs won't see a change.
2024-06-13 15:19:03 +02:00
Guido Günther 8d4c2590cb doc: Fix URLs
Don't use Markdown markup as it looks odd in the generated page.
2024-06-13 07:44:39 +02:00
Guido Günther 17d910651d doc: Document feedback types
This allows us to remove the list from the README
2024-06-13 07:44:36 +02:00
Guido Günther 48b5ca547f manpages: Fix whatis entry 2023-09-01 13:06:08 +02:00
Guido Günther 93dab70f24 manpages: Improve references 2023-09-01 13:00:49 +02:00
Guido Günther b96a25394b feedback-themes: Improve wording 2023-09-01 13:00:49 +02:00
Guido Günther 154701fee6 doc: Add manpage for feedback themes
This should direct users to the documentation.

Prompted by https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1050762
2023-08-29 12:19:54 +02:00
Guido Günther 2ca7a329b7 doc: Better cross reference manpages 2023-08-29 12:14:11 +02:00
Guido Günther ae85ac15d5 doc: Fix link to spec in manpage 2023-01-06 15:04:29 +00:00
Guido Günther 0d50276f94 feedback-theme: Add screen-shot event
Used to indicate that a screen shot is being taken.
2023-01-02 11:45:11 +01:00
Guido Günther b09f37b065 event-naming-spec: Separate application and system events
Make it obvious which events are meant to be used by "normal" GUI
applications in contrast to system components like desktop shells or
components monitoring the battery, etc.

This was prompted by
https://github.com/flatpak/xdg-desktop-portal/issues/929
2023-01-02 11:39:27 +01:00
Guido Günther 49f697b232 doc: Add manual page for fbd-theme-validate 2022-12-13 13:47:18 +01:00
Guido Günther 584d4ddb6f doc: Convert manpages to rst
This will make it more fun to add details and more manpages.
2022-12-13 13:47:18 +01:00
Chris Vogel bd16d5761d doc: feedback stops when client disconnects
extended documentation for feedbackd.
2022-12-12 11:20:51 +00:00
Guido Günther 6acdb67b78 Include specifications in the documentation
Now that we can use markdown easily add them as they provide
help to the developer what events exist, etc.
2022-12-06 13:58:04 +01:00
Guido Günther a150c2cbc3 Switch library documentation to gi-docgen
Switch from gtk-doc to gi-docgen for the library documentation and
adjust the source files accordingly.

We don't bother about the daemon doc headers as they're not built into
any docs atm.

Closes: #56
2022-12-06 12:44:54 +01:00
Chris Vogel 64956ea4df docs: Update references to documentation from branch master to branch main. 2022-11-28 10:22:26 +01:00
Pablo Correa Gómez fe0036e339 Fix typos in documentation 2021-10-14 02:06:39 +02:00
Guido Günther 3503fe0293 docs: Fix --profile short option
It's '-P', not '-p'.
2021-08-09 11:46:30 +02:00
Luca Weiss ed0253fc44 Fix typos 2020-10-26 08:21:05 +00:00
Arnaud Ferraris ffc07883b5 doc: feedbackd: add short description
Lintian issues a warning if short description is empty.
2020-07-12 16:56:47 +02:00
Arnaud Ferraris 1675dd24db doc: fix typos 2020-07-12 16:56:31 +02:00
Guido Günther 41304c36fd cli: Allow to set profile per event
We allowed set the global profile via `-P` use it as per event
profile when used with `-E`.

Ironically the manpage always said it'd be that way.
2020-07-10 09:20:04 +00:00
Guido Günther d780dd4f57 docs: Add feedbackd manpage
Closes: #12
2020-07-04 11:30:46 +00:00
Guido Günther afcb57ab90 doc: Add fbcli manpage 2020-07-04 11:30:46 +00:00
Guido Günther a2e86bd277 docs: Move descriptive text to overview.xml
Our short intro paragraph did not get rendered otherwise.
2020-02-25 18:37:23 +01:00
Guido Günther 3663b7d149 Initial commit
Signed-off-by: Guido Günther <agx@sigxcpu.org>
2020-02-14 17:40:34 +01:00