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

@@ -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)
+- [Event naming spec draft](./doc/Event-naming-spec-0.0.0.md)
-- [Feedback-theme-spec draft](./Feedback-theme-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

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:

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

doc/fbcli.xml

@@ -52,7 +52,7 @@ print help and exit
 <para>
   Submit the given event to <command>feedbackd</command>. Valid events are
   listes in the event naming spec at
-  <ulink url="https://source.puri.sm/Librem5/feedbackd/-/blob/main/Event-naming-spec-0.0.0.md"/>
+  <ulink url="https://source.puri.sm/Librem5/feedbackd/-/blob/main/doc/Event-naming-spec-0.0.0.md"/>
 </para>
 </varlistentry>
 

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",
 ]

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()