Connect the reactions and dev docs

yetanalytics · Oct 4, 2024 · 344997f · 344997f
1 parent e3284c7
commit 344997f
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/doc/dev.md b/doc/dev.md
@@ -121,7 +121,7 @@ Sample insert and query inputs can be found in the distribution at `bench/`
 
 Reactions are internally stored in SQL LRS as JSON object. Each reaction contains an `id`, `title`, `active`, `created`, `modified`, and `ruleset` property. Each `ruleset` is a JSON object that in turn contains the properties `conditions`, `template`, and `identityPaths`.
 
-The following is an example reaction JSON object:
+The following is the example reaction from [the tutorial](reactions.md), in JSON format:
 ```json
 {
  "id": "019257f4-d533-8c0b-8730-28b82f383982",

diff --git a/doc/reactions.md b/doc/reactions.md
@@ -8,7 +8,6 @@ Reactions allow SQL LRS to watch for patterns in submitted xAPI data and dynamic
 
 To use Reactions the `LRSQL_ENABLE_REACTIONS` environment variable or the `enableReactions` LRS configuration property must be set to `true`. Reactions are disabled by default.
 
-
 ![reactions table](images/reactions/table.png)
 To view a reaction, click on the reaction in the table above. This will display a reaction view page.
 
@@ -137,4 +136,8 @@ Then the following statement will be added subsequently (note that some unrelate
 }
 ```
 
+### JSON Format
+
+Reactions are stored internally in JSON format. For an example, see the [developer documentation](dev.md#reaction-json).
+
 [<- Back to Index](index.md)