Restructure content

Author: Ndpnt

content/_index.en.md

@@ -0,0 +1,5 @@
+---
+title: "Analysis"
+weight: 2
+---
+

content/analysis/_index.md

@@ -0,0 +1,4 @@
+---
+title: How to
+weight: 1
+---

content/analysis/how-to/_index.md

@@ -1,5 +1,5 @@
 ---
-title: "How to navigate history"
+title: Navigate history
 weight: 1
 aliases: /navigate-history/
 ---

content/terms/how-to-navigate-history.md renamed to content/analysis/how-to/how-to-navigate-history.md

@@ -1,5 +1,5 @@
 ---
-title: "How to publish a memo"
+title: Publish a memo
 ---
 
 # How to publish a memo
@@ -10,7 +10,7 @@ No technical skills are required.
 
 ## Prerequisites
 
-- A drafted memo compliant with the [copywriting reference]({{< relref "/memos/copywriting-reference" >}}).
+- A drafted memo compliant with the [copywriting reference]({{< relref "/analysis/reference/copywriting" >}}).
 
 ## 1. Send
 

content/memos/how-to-publish.en.md renamed to content/analysis/how-to/publish.md

@@ -0,0 +1,4 @@
+---
+title: Reference
+weight: 2
+---

content/analysis/reference/_index.md

@@ -1,5 +1,5 @@
 ---
-title: "Copywriting reference"
+title: Copywriting
 ---
 
 # Copywriting reference

content/memos/copywriting-reference.en.md renamed to content/analysis/reference/copywriting.md

@@ -1,4 +1,4 @@
 ---
-title: API
-weight: 4
+title: Programmatic access
+weight: 8
 ---

content/api/_index.md

@@ -0,0 +1,61 @@
+---
+title: CLI
+weight: 1
+---
+
+# CLI
+
+Once the engine module is installed as a dependency within another module, the `ota` command with the following subcommands is available.
+
+In these commands:
+
+- **`<service_id>`** is the case sensitive name of the service declaration file without the extension. For example, for `Twitter.json`, the service ID is `Twitter`.
+- **`<terms_type>`** is the property name used under the `documents` property in the declaration to declare a terms. For example, in the getting started declaration, the terms type declared is `Privacy Policy`.
+
+#### Tracking
+
+{{< configOption name="ota track" type="command" description="Track the current terms of services according to provided declarations. The declarations, snapshots and versions paths are defined in the configuration." example="npx ota track" >}}
+
+> Note that the snapshots and versions will be recorded at the moment the command is executed, on top of the existing local history. If a shared history already exists and the goal is to add on top of it, that history has to be downloaded before executing that command.
+
+{{< configOption name="ota track --help" type="command" description="Show help and available options for track command" example="npx ota track --help" >}}
+
+{{< configOption name="ota track --services" type="command" description="Track terms of specific services only" example="npx ota track --services \"<service_id>\" [\"<service_id>\"...]" >}}
+
+{{< configOption name="ota track --services --types" type="command" description="Track specific terms types of specific services only" example="npx ota track --services \"<service_id>\" [\"<service_id>\"...] --types \"<terms_type>\" [\"<terms_type>\"...]" >}}
+
+{{< configOption name="ota track --schedule" type="command" description="Track terms on a schedule (four times daily)" example="npx ota track --schedule" >}}
+
+#### Validating
+
+{{< configOption name="ota validate" type="command" description="Check that all declarations allow recording a snapshot and a version properly. If service IDs are provided, check only those services." example="npx ota validate [--services <service_id>...] [--types <terms_type>...]" >}}
+
+{{< configOption name="ota validate --schema-only" type="command" description="Check that all declarations are readable by the engine. Allows for a much faster check of declarations, but does not check that the terms are actually accessible." example="npx ota validate --schema-only [--services <service_id>...] [--types <terms_type>...]" >}}
+
+{{< configOption name="ota validate --modified" type="command" description="Run ota validate only on files that have been modified in Git" example="npx ota validate --modified" >}}
+
+#### Linting
+
+{{< configOption name="ota lint" type="command" description="Test the format of declarations' normalisation. Use --fix to automatically correct formatting mistakes and ensure that all declarations are standardised." example="npx ota lint [--services <service_id>...] [--fix] [--modified]" >}}
+
+#### Dataset publishing
+
+{{< configOption name="ota dataset" type="command" description="Export the versions dataset into a ZIP file and publish it to GitHub releases. The dataset title and the URL of the versions repository are defined in the configuration." example="npx ota dataset [--file <filename>]" >}}
+
+To export the dataset into a ZIP file and publish it on GitHub releases:
+
+{{< configOption name="ota dataset --publish" type="command" description="Export and publish dataset to GitHub releases" example="GITHUB_TOKEN=ghp_XXXXXXXXX npx ota dataset --publish" >}}
+
+The `GITHUB_TOKEN` can also be defined in a [`.env` file](#environment-variables).
+
+To export, publish the dataset and remove the local copy that was created after it has been uploaded:
+
+{{< configOption name="ota dataset --publish --remove-local-copy" type="command" description="Export, publish dataset and remove local copy after upload" example="GITHUB_TOKEN=ghp_XXXXXXXXX npx ota dataset --publish --remove-local-copy" >}}
+
+{{< configOption name="ota dataset --schedule" type="command" description="Schedule export, publishing and local copy removal" example="GITHUB_TOKEN=ghp_XXXXXXXXX npx ota dataset --schedule --publish --remove-local-copy" >}}
+
+#### Exposing the collection API
+
+{{< configOption name="ota serve" type="command" description="Start the collection Web API server. The Web API will be available under http://localhost:<port>/<basePath>/<apiVersion>/<resource>. The server port and basePath are defined in the configuration." example="npx ota serve" >}}
+
+> For example, with the default configuration, the list of services can be found at [`http://localhost:3000/api/v1/services`](http://localhost:3000/api/v1/services).

content/api/cli.md

@@ -1,9 +1,9 @@
 ---
-title: Collection
+title: Collection REST API
 weight: 2
 ---
 
-# Collection Web API [Beta]
+# Collection Web API
 
 As Open Terms Archive is decentralised, each instance embarks its own API. The documentation relevant to the specific version of the engine on that instance is provided on that instance itself.