Merge pull request #5 from quixai/task/fix-h1-titles

Fixing missing H1 title issue

docs/apis/data-catalogue-api/aggregate-tags.md

@@ -1,8 +1,10 @@
+# Aggregate data by tags
+
 If you need to compare data across different values for a given tag,
 you’ll want to group results by that tag. You can do so via the
 `/parameters/data` endpoint.
 
-# Before you begin
+## Before you begin
 
   - If you don’t already have any Stream data in your workspace, you can
     use any Source of our [Quix
@@ -11,7 +13,7 @@ you’ll want to group results by that tag. You can do so via the
   - [Get a Personal Access Token](authenticate.md)
     to authenticate each request.
 
-# Using the groupBy property
+## Using the groupBy property
 
 You can supply a list of Tags in the `groupBy` array to aggregate
 results by. For example, you could group a set of Speed readings by the
@@ -56,7 +58,7 @@ e.g.
 }
 ```
 
-# Using aggregationType
+## Using aggregationType
 
 For meaningful aggregations, you should specify a type of aggregation
 function for each parameter. When specifying the parameters to receive,

docs/apis/data-catalogue-api/aggregate-time.md

@@ -1,7 +1,9 @@
+# Aggregate data by time
+
 You can downsample and upsample data from the catalogue using the
 `/parameters/data` endpoint.
 
-# Before you begin
+## Before you begin
 
   - If you don’t already have any Stream data in your workspace, you can
     use any Source of our [Quix
@@ -10,7 +12,7 @@ You can downsample and upsample data from the catalogue using the
   - [Get a Personal Access Token](authenticate.md)
     to authenticate each request.
 
-# Aggregating and interpolating
+## Aggregating and interpolating
 
 The JSON payload can include a `groupByTime` property, an object with
 the following members:

docs/apis/data-catalogue-api/authenticate.md

@@ -1,8 +1,10 @@
-# Before you begin
+# Authenticate
+
+## Before you begin
 
   - Sign up on the Quix Portal
 
-# Get a Personal Access Token
+## Get a Personal Access Token
 
 You should authenticate requests to the Catalogue API using a Personal
 Access Token (PAT). This is a time-limited token which you can revoke if
@@ -31,7 +33,7 @@ Follow these steps to generate a PAT:
 > with the API, use tokens as environment variables instead of
 > hardcoding them into your programs.
 
-# Sign all your requests using this token
+## Sign all your requests using this token
 
 Make sure you accompany each request to the API with an `Authorization`
 header using your PAT as a bearer token, as follows:

docs/apis/data-catalogue-api/filter-tags.md

@@ -1,7 +1,9 @@
+# Tag filtering
+
 If you supply Tags with your parameter data, they will act as indexes,
 so they can be used to efficiently filter data.
 
-# Before you begin
+## Before you begin
 
   - If you don’t already have any Stream data in your workspace, you can
     use any Source of our [Quix
@@ -10,7 +12,7 @@ so they can be used to efficiently filter data.
   - [Get a Personal Access Token](authenticate.md)
     to authenticate each request.
 
-# Using tag filters
+## Using tag filters
 
 When calling the `/parameters/data` endpoint, you can include a
 `tagFilters` property in your payload. This property references an array
@@ -70,7 +72,7 @@ combination, so:
 
 Is useless because a LapNumber cannot be both "2.0" and "4.0".
 
-## Supported operators
+### Supported operators
 
 Each object in the `tagFilters` array can support the following
 `operator` values:

docs/apis/data-catalogue-api/get-swagger.md

@@ -1,3 +1,5 @@
+# Getting Swagger url
+
 You can access documentation and a basic playground for [the Data
 Catalogue API](intro.md) via
 [Swagger](https://swagger.io/). The exact URL is workspace-specific, and

docs/apis/data-catalogue-api/intro.md

@@ -1,3 +1,5 @@
+# Introduction
+
 The Data Catalogue HTTP API allows you to fetch data stored in the Quix
 platform. You can use it for exploring the platform, prototyping
 applications, or working with stored data in any language with HTTP
@@ -8,7 +10,7 @@ documentation](get-swagger.md). Read on for
 a guide to using the API, including real-world examples you can execute
 from your language of choice, or via the command line using `curl`.
 
-# Preparation
+## Preparation
 
 Before using any of the endpoints, you’ll need to know how to
 [authenticate your requests](authenticate.md) and
@@ -20,7 +22,7 @@ use to be meaningful. You can use any Source of our [Quix
 Library](../../platform/samples/samples.md) to do this using the Quix
 portal.
 
-# Topics covered
+## Topics covered
 
 |                                                                    |                    |                                           |
 | ------------------------------------------------------------------ | ------------------ | ----------------------------------------- |

docs/apis/data-catalogue-api/raw-data.md

@@ -1,8 +1,10 @@
+# Raw data
+
 Access persisted raw data by specifyng the parameters you’re interested
 in. Add restrictions based on Stream or timings for finer-grained
 results.
 
-# Before you begin
+## Before you begin
 
   - If you don’t already have any Stream data in your workspace, you can
     use any Source of our [Quix
@@ -11,13 +13,13 @@ results.
   - [Get a Personal Access Token](authenticate.md)
     to authenticate each request.
 
-# Using the /parameters/data endpoint
+## Using the /parameters/data endpoint
 
 Raw telemetry data is available via the `/parameters/data` endpoint.
 
-# Fetching specific parameters
+## Fetching specific parameters
 
-## Request
+### Request
 
 You can filter by a number of different factors but, at minimum, you’ll
 need to supply one or more parameters to fetch:
@@ -36,7 +38,7 @@ be `numericParameters`, `stringParameters` or `binaryParameters`.
 Parameters are returned in a union, so if you request several, you’ll
 get back all parameters that match.
 
-## Example
+### Example
 
 ``` bash
 curl "https://${domain}.platform.quix.ai/parameters/data" \
@@ -65,7 +67,7 @@ from the above call might look something like this:
 }
 ```
 
-## Restricting by Stream or time
+### Restricting by Stream or time
 
 In reality, you’ll have far more data in the catalogue, so you’ll want
 to filter it. Three remaining properties of the request object allow you

docs/apis/data-catalogue-api/request.md

@@ -1,3 +1,5 @@
+# Forming a request
+
 How you send requests to the Data Catalogue API will vary depending on
 the client or language you’re using. But the API still has behaviour and
 expectations that is common across all clients.
@@ -7,14 +9,14 @@ expectations that is common across all clients.
 > The examples in this section show how to use the popular
 > [`curl`](https://curl.se/) command line tool.
 
-# Before you begin
+## Before you begin
 
   - Sign up on the Quix Portal
 
   - Read about [Authenticating with the Data Catalogue
     API](authenticate.md)
 
-# Endpoint URLs
+## Endpoint URLs
 
 The Data Catalogue API is available on a per-workspace basis, so the
 subdomain is based on a combination of your organisation and workspace
@@ -28,7 +30,7 @@ So your final endpoint URL will look something like:
 
     https://telemetry-query-acme-weather.platform.quix.ai/
 
-# Method
+## Method
 
 Most endpoints use the `POST` method, even those that just fetch data.
 Ensure your HTTP client sends `POST` requests as appropriate.
@@ -41,7 +43,7 @@ below).
 curl -X POST ...
 ```
 
-# Payload
+## Payload
 
 For most methods, you’ll need to send a JSON object containing supported
 parameters. You’ll also need to set the appropriate content type for the
@@ -66,7 +68,7 @@ curl -d '{"key": "value"}' ...
 curl -d "@data.json" ...
 ```
 
-# Complete curl example
+## Complete curl example
 
 You should structure most of your requests to the API around this
 pattern:

docs/apis/data-catalogue-api/streams-filtered.md

@@ -1,7 +1,9 @@
+# Filtered streams
+
 To fetch specific streams, you can include various filters with your
 request to the [`/streams`](#) endpoint.
 
-# Before you begin
+## Before you begin
 
   - If you don’t already have any Stream data in your workspace, you can
     use any Source of our [Quix
@@ -10,7 +12,7 @@ request to the [`/streams`](#) endpoint.
   - [Get a Personal Access Token](authenticate.md)
     to authenticate each request.
 
-# Fetch a single stream via ID
+## Fetch a single stream via ID
 
 The most basic filter matches against a stream’s ID.
 
@@ -24,7 +26,7 @@ curl "https://${domain}.platform.quix.ai/streams" \
 Note that you can supply multiple IDs in the `streamIds` array to match
 multiple streams.
 
-# Filtering streams on basic properties
+## Filtering streams on basic properties
 
 The **location** of a stream defines its position in a hierarchy. A
 stream location looks just like a filesystem path. You can filter
@@ -78,7 +80,7 @@ curl "https://${domain}.platform.quix.ai/streams" \
      -d '{"excludeStatuses": [ "Interrupted", "Closed" ]}'
 ```
 
-# Filtering streams on metadata
+## Filtering streams on metadata
 
 You can associate metadata with your streams. This can be used, for
 example, to store the circuit a car has travelled around, or the player
@@ -126,7 +128,7 @@ As before, the response is an array of Stream objects:
 }]
 ```
 
-# Ordering results
+## Ordering results
 
 Calls to the `/streams` endpoint can include an `ordering` property in
 the payload. This references an array of properties to sort on, each one

docs/apis/data-catalogue-api/streams-models.md

@@ -1,8 +1,10 @@
+# Streams with models
+
 One stream can derive from another, for example, acting as a model in a
 pipeline. This relationship can be inspected using the `/streams/models`
 endpoint.
 
-# Before you begin
+## Before you begin
 
   - If you don’t already have any Stream data in your workspace, you can
     use any Source of our [Quix
@@ -11,7 +13,7 @@ endpoint.
   - [Get a Personal Access Token](authenticate.md)
     to authenticate each request.
 
-# Fetching model data
+## Fetching model data
 
 The hierarchy is represented as a parent/child structure where a stream
 can have an optional parent and any number of children.

docs/apis/data-catalogue-api/streams-paged.md

@@ -1,10 +1,12 @@
+# Paged streams
+
 You can fetch all streams within a
 [workspace](../../platform/definitions.md#_workspace), across
 [topics](../../platform/definitions.md#_topics) and locations, with a
 single call. If you’re working with a large number of streams, you can
 use pagination parameters to group the results into smaller pages.
 
-# Before you begin
+## Before you begin
 
   - If you don’t already have any Stream data in your workspace, you can
     use any Source of our [Quix
@@ -13,7 +15,7 @@ use pagination parameters to group the results into smaller pages.
   - [Get a Personal Access Token](authenticate.md)
     to authenticate each request.
 
-# Fetching all streams
+## Fetching all streams
 
 The [`/streams`](#) endpoint provides read access to all streams within
 the workspace. Sending an empty JSON object in your request body will
@@ -24,7 +26,7 @@ return all streams.
 > Even if you’re not supplying any parameters, you must still send a
 > valid empty object as JSON data in the body of your request.
 
-## Example request
+### Example request
 
 ``` shell
 curl "https://${domain}.platform.quix.ai/streams" \
@@ -33,7 +35,7 @@ curl "https://${domain}.platform.quix.ai/streams" \
      -d "{}"
 ```
 
-## Example response
+### Example response
 
 The JSON returned consists of an array of Stream objects:
 
@@ -53,7 +55,7 @@ The JSON returned consists of an array of Stream objects:
 }]
 ```
 
-# Fetching streams page by page
+## Fetching streams page by page
 
 To reduce the size of the response, you should page these results with
 the [`paging`](#) property. Include this in the JSON object you send in
@@ -76,7 +78,7 @@ page, use this value:
 }
 ```
 
-## Example request
+### Example request
 
 ``` shell
 curl "https://${domain}.platform.quix.ai/streams" \

docs/apis/streaming-reader-api/authenticate.md

@@ -1,8 +1,10 @@
-# Before you begin
+# Authenticate
+
+## Before you begin
 
   - Sign up on the Quix Portal
 
-# Get a Personal Access Token
+## Get a Personal Access Token
 
 You should authenticate requests to the Streaming Reader API using a
 Personal Access Token (PAT). This is a time-limited token which you can

docs/apis/streaming-reader-api/intro.md

@@ -1,11 +1,13 @@
+# Introduction
+
 As an alternative to [the SDK](../../sdk/read.md), the Quix platform
 supports real-time data streaming over WebSockets. Clients can receive
 updates on data and definitions for parameters and events, as they
 happen. The examples shown use the Microsoft
 [SignalR](https://docs.microsoft.com/en-us/aspnet/core/signalr/javascript-client?view=aspnetcore-5.0)
 JavaScript client library.
 
-# Topics
+## Topics
 
   - [Set up SignalR](signalr.md)
 

docs/apis/streaming-reader-api/reading-data.md

@@ -1,11 +1,13 @@
+# Reading data
+
 Before you can read data from a stream, you need to subscribe to an
 event of the Streaming Reader service like ParameterData or EventData.
 
 You can get a full list of [Subscriptions and
 Events](subscriptions.md) available in
 this of [section](subscriptions.md).
 
-# Example
+## Example
 
 The following code sample shows how to use the SignalR client library
 to: