Update documentation (#119)

Updates documentation to reflect the latest state of Freyja

Fixes #112

.accepted_words.txt

@@ -42,6 +42,8 @@ csproj
 csr
 cv
 cvd
+DataAdapter
+DataAdapterFactory
 depgen
 der
 dev
@@ -98,6 +100,7 @@ launchSetting
 libs
 libssl
 lifecycle
+loopback
 mailto
 ManagedSubscribeDataAdapter
 MappingAdapter
@@ -160,6 +163,7 @@ signkey
 snapd
 src
 SSL
+standalone
 stdout
 STRUCT
 struct

README.md

@@ -40,9 +40,9 @@ This guide uses `apt` as the package manager in the examples. You may need to su
 
 To use Freyja, you will need to implement some adapters and write the main executable that will run the Freyja application.
 
-For a guide on how to get started quickly by running some minimal examples, see the [Quickstart Guide](docs/quickstart.md).
+For a guide on how to get started quickly by running some minimal examples, see the [Quickstart Guide](docs/tutorials/quickstart.md).
 
-For more advanced topics on how to implement and use your own adapters, see the [Custom Adapters Guide](docs/custom-adapters.md).
+For more advanced topics on how to implement and use your own adapters, see the [Custom Adapters Guide](docs/tutorials/custom-adapters.md).
 
 <!--alex disable he-she her-him brothers-sisters-->
 ## Why "Freyja"?

adapters/data/grpc_data_adapter/README.md

@@ -9,7 +9,7 @@ This adapter supports the following configuration settings:
 - `consumer_address`: The address for the adapter's consumer. The adapter's gRPC server will be hosted on this address.
 - `advertised_consumer_address`: (Optional) The advertised address for the adapter's consumer. This is the address that will be reported as the callback address to providers, enabling scenarios where the providers should use a different address from the actual hosting address. If not specified, this adapter will default to using the consumer address.
 
-This adapter supports [config overrides](../../../docs/config-overrides.md). The override filename is `grpc_data_adapter_config.json`, and the default config is located at `res/grpc_data_adapter_config.default.json`.
+This adapter supports [config overrides](../../../docs/tutorials/config-overrides.md). The override filename is `grpc_data_adapter_config.json`, and the default config is located at `res/grpc_data_adapter_config.default.json`.
 
 ## Integrating with this Adapter
 

adapters/data/http_mock_data_adapter/README.md

@@ -9,4 +9,4 @@ This adapter supports the following configuration settings:
 - `callback_address`: The address for the adapter. This is the address that the Mock Digital Twin will use for callbacks. This should be a URI with no scheme and no port.
 - `starting_port`: The starting port number to use when creating adapters. The factory will increment the port it uses each time an adapter is created.
 
-This adapter supports [config overrides](../../../docs/config-overrides.md). The override filename is `http_mock_data_adapter_config.json`, and the default config is located at `res/http_mock_data_adapter_config.default.json`.
+This adapter supports [config overrides](../../../docs/tutorials/config-overrides.md). The override filename is `http_mock_data_adapter_config.json`, and the default config is located at `res/http_mock_data_adapter_config.default.json`.

adapters/data/in_memory_mock_data_adapter/README.md

@@ -16,7 +16,7 @@ This adapter supports the following configuration settings:
       - `end`: The other bound for the signal value
       - `delta`: The amount to add to the signal value at each iteration. If this operation would exceed the specified bounds, then the signal value saturates at the boundary value.
 
-This adapter supports [config overrides](../../../docs/config-overrides.md). The override filename is `in_memory_mock_data_adapter_config.json`, and the default config is located at `res/in_memory_mock_data_adapter_config.default.json`.
+This adapter supports [config overrides](../../../docs/tutorials/config-overrides.md). The override filename is `in_memory_mock_data_adapter_config.json`, and the default config is located at `res/in_memory_mock_data_adapter_config.default.json`.
 
 ## Behavior
 

adapters/data/managed_subscribe_data_adapter/README.md

@@ -11,7 +11,7 @@ This adapter supports the following configuration settings:
 
 The above values define the frequency at which the adapter requests a provider to transfer data.
 
-This adapter supports [config overrides](../../../docs/config-overrides.md). The override filename is `managed_subscribe_data_adapter_config.json`, and the default config is located at `res/managed_subscribe_data_adapter_config.default.json`.
+This adapter supports [config overrides](../../../docs/tutorials/config-overrides.md). The override filename is `managed_subscribe_data_adapter_config.json`, and the default config is located at `res/managed_subscribe_data_adapter_config.default.json`.
 
 ## Integrating with this Adapter
 

adapters/data/mqtt_data_adapter/README.md

@@ -8,7 +8,7 @@ This adapter supports the following configuration settings:
 
 - `keep_alive_interval_s`: The keep alive interval for MQTT communications, in seconds
 
-This adapter supports [config overrides](../../../docs/config-overrides.md). The override filename is `mqtt_data_adapter_config.json`, and the default config is located at `res/mqtt_data_adapter_config.default.json`.
+This adapter supports [config overrides](../../../docs/tutorials/config-overrides.md). The override filename is `mqtt_data_adapter_config.json`, and the default config is located at `res/mqtt_data_adapter_config.default.json`.
 
 ## Integrating with this Adapter
 

adapters/digital_twin/in_memory_mock_digital_twin_adapter/README.md

@@ -15,4 +15,4 @@ This adapter supports the following configuration settings:
       - `operations`: A list of operations that can be used to access this entity.
       - `uri`: The uri that is used to invoke a provider. This is used as the key when calling functions on the adapters. If you're using the `in-memory` protocol, requests are not actually submitted to this uri so it does not need to be a real endpoint.
 
-This adapter supports [config overrides](../../../docs/config-overrides.md). The override filename is `in_memory_digital_twin_config.json`, and the default config is located at `res/in_memory_digital_twin_config.default.json`.
+This adapter supports [config overrides](../../../docs/tutorials/config-overrides.md). The override filename is `in_memory_digital_twin_config.json`, and the default config is located at `res/in_memory_digital_twin_config.default.json`.

adapters/digital_twin/mock_digital_twin_adapter/README.md

@@ -8,4 +8,4 @@ This adapter supports the following configuration settings:
 
 - `digital_twin_service_uri`: the base uri for the Mock Digital Twin Service
 
-This adapter supports [config overrides](../../../docs/config-overrides.md). The override filename is `mock_digital_twin_adapter_config.json`, and the default config is located at `res/mock_digital_twin_adapter_config.default.json`.
+This adapter supports [config overrides](../../../docs/tutorials/config-overrides.md). The override filename is `mock_digital_twin_adapter_config.json`, and the default config is located at `res/mock_digital_twin_adapter_config.default.json`.

adapters/mapping/in_memory_mock_mapping_adapter/README.md

@@ -16,7 +16,7 @@ This adapter supports the following configuration settings:
     - `emit_on_change`: a boolean indicating whether data emission should be skipped if the value hasn't changed since the last emission. Set to `true` to enable this behavior.
     - `conversion`: a conversion that should be applied. Set to `null` if no conversion is needed. Otherwise the conversion is configured with the `mul` and `offset` properties, and the value `y` that is emitted is calculated as `y = mul * x + offset`. Note that conversions are only supported for signal values which can be parsed as `f64`.
 
-This adapter supports [config overrides](../../../docs/config-overrides.md). The override filename is `mock_mapping_config.json`, and the default config is located at `res/mock_mapping_config.default.json`.
+This adapter supports [config overrides](../../../docs/tutorials/config-overrides.md). The override filename is `mock_mapping_config.json`, and the default config is located at `res/mock_mapping_config.default.json`.
 
 ## Behavior
 

adapters/mapping/mock_mapping_service_adapter/README.md

@@ -20,4 +20,4 @@ This adapter supports the following configuration settings:
 - `retry_interval_ms`: the interval between subsequent retry attempts, in milliseconds
 - `mock_mapping_service_url`: the url for the Mock Mapping Service
 
-This adapter supports [config overrides](../../../docs/config-overrides.md). The override filename is `mock_mapping_adapter_config.json`, and the default config is located at `res/mock_mapping_adapter_config.default.json`.
+This adapter supports [config overrides](../../../docs/tutorials/config-overrides.md). The override filename is `mock_mapping_adapter_config.json`, and the default config is located at `res/mock_mapping_adapter_config.default.json`.