From 6acdb67b78198c1202d8e89de8332553e6e57069 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Guido=20G=C3=BCnther?= Date: Tue, 6 Dec 2022 11:21:06 +0100 Subject: [PATCH] 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. --- README.md | 8 ++++---- .../Event-naming-spec-0.0.0.md | 5 ++++- .../Feedback-theme-spec-0.0.0.md | 7 +++++-- doc/fbcli.xml | 2 +- doc/libfeedback.toml.in | 2 ++ doc/meson.build | 2 ++ 6 files changed, 18 insertions(+), 8 deletions(-) rename Event-naming-spec-0.0.0.md => doc/Event-naming-spec-0.0.0.md (98%) rename Feedback-theme-spec-0.0.0.md => doc/Feedback-theme-spec-0.0.0.md (88%) diff --git a/README.md b/README.md index 924e3b2..b36c67f 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,7 @@ See `examples/` for a simple python example using GObject introspection. # How it works -We're using a [event naming spec](./Event-naming-spec-0.0.0.md) +We're using a [event naming spec](./doc/Event-naming-spec-0.0.0.md) similar to http://0pointer.de/public/sound-naming-spec.html to name events. This will allow us to act as a system sound library so applications only need to call into this library and things like @@ -221,8 +221,8 @@ GSETTINGS_SCHEMA_DIR=_build/data/ gsettings set org.sigxcpu.feedbackd.applicatio # Documentation - [Libfeedback API](https://honk.sigxcpu.org/projects/feedbackd/doc/) -- [Event naming spec draft](./Event-naming-spec-0.0.0.md) -- [Feedback-theme-spec draft](./Feedback-theme-spec-0.0.0.md) +- [Event naming spec draft](./doc/Event-naming-spec-0.0.0.md) +- [Feedback-theme-spec draft](./doc/Feedback-theme-spec-0.0.0.md) [debian/control]: ./debian/control#L5 -[1]: https://source.puri.sm/Librem5/feedbackd-device-themes) +[1]: https://source.puri.sm/Librem5/feedbackd-device-themes diff --git a/Event-naming-spec-0.0.0.md b/doc/Event-naming-spec-0.0.0.md similarity index 98% rename from Event-naming-spec-0.0.0.md rename to doc/Event-naming-spec-0.0.0.md index f7db692..deceab4 100644 --- a/Event-naming-spec-0.0.0.md +++ b/doc/Event-naming-spec-0.0.0.md @@ -1,4 +1,5 @@ -This is similar in spirit (and heavily based on) to the [Sound naming spec][]. +Title: Event Naming Specification +Slug: Event Naming Specification # Overview @@ -11,6 +12,8 @@ Events, and a larger list with many more examples to help with the creation of extended Events for third party applications, with different event types and usage. +This is similar in spirit (and heavily based on) to the [Sound naming spec][]. + # Context The list of default contexts for the feedback theme are: diff --git a/Feedback-theme-spec-0.0.0.md b/doc/Feedback-theme-spec-0.0.0.md similarity index 88% rename from Feedback-theme-spec-0.0.0.md rename to doc/Feedback-theme-spec-0.0.0.md index bae695c..214cce8 100644 --- a/Feedback-theme-spec-0.0.0.md +++ b/doc/Feedback-theme-spec-0.0.0.md @@ -1,3 +1,6 @@ +Title: Feedback Theme Specification +Slug: Feedback Theme Specification + # Overview A feedback theme defines the kind of feedback that events (as @@ -64,7 +67,7 @@ silent: ``` At the time of writing the theme format is daemon dependent. E.g. feedbackd -uses a format [similar to the above in JSON](./data/default.json). +uses a format [similar to the above in JSON](https://source.puri.sm/Librem5/feedbackd/-/blob/main/data/default.json) # Recommendations @@ -75,4 +78,4 @@ uses a format [similar to the above in JSON](./data/default.json). be used. - The full feedback theme can use any available feedback mechanisms -[Event naming spec]: ./Event-naming-spec-0.0.0.md +[Event naming spec]: https://source.puri.sm/Librem5/feedbackd/-/blob/main/doc/Event-naming-spec-0.0.0.md diff --git a/doc/fbcli.xml b/doc/fbcli.xml index fe847c9..282e045 100644 --- a/doc/fbcli.xml +++ b/doc/fbcli.xml @@ -52,7 +52,7 @@ print help and exit Submit the given event to feedbackd. Valid events are listes in the event naming spec at - + diff --git a/doc/libfeedback.toml.in b/doc/libfeedback.toml.in index 012ca0e..04ab9ff 100644 --- a/doc/libfeedback.toml.in +++ b/doc/libfeedback.toml.in @@ -39,4 +39,6 @@ content_files = [ "overview.md", "build-howto.md", "initialization.md", + "Event-naming-spec-0.0.0.md", + "Feedback-theme-spec-0.0.0.md", ] diff --git a/doc/meson.build b/doc/meson.build index 131fa5f..b4a2a27 100644 --- a/doc/meson.build +++ b/doc/meson.build @@ -4,6 +4,8 @@ expand_content_md_files = [ 'overview.md', 'build-howto.md', 'initialization.md', + 'Event-naming-spec-0.0.0.md', + 'Feedback-theme-spec-0.0.0.md', ] toml_data = configuration_data()