Skip to content

Commit

Permalink
daemon/cli: make docs use relative paths
Browse files Browse the repository at this point in the history
They were absolute for easier reasoning but that doesn't
work when hosting with GitHub Pages + prefix path, e.g `/daemon/`
  • Loading branch information
hinto-janai committed Aug 19, 2023
1 parent ffb0e17 commit 4ee34f5
Show file tree
Hide file tree
Showing 344 changed files with 1,642 additions and 1,642 deletions.
2 changes: 1 addition & 1 deletion cli/mdbook/docs/authorization.html
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ <h1 class="menu-title">festival-cli v1.0.0</h1>
<h1 id="authorization"><a class="header" href="#authorization">Authorization</a></h1>
<p><code>festivald</code> has a <a href="https://en.wikipedia.org/wiki/Basic_access_authentication"><code>Basic access authentication</code></a> option, with a username + password setup.</p>
<p>If enabled, <code>festival-cli</code> must also use <code>--authorization</code> or setup the <a href="config.html"><code>authorization</code></a> config option to connect to it.</p>
<p><code>festival-cli</code> must connect to <code>festivald</code> over <code>HTTPS</code> or <a href="/tor.html"><code>.onion</code></a> if authorization is enabled or <code>festival-cli</code> will refuse to start.</p>
<p><code>festival-cli</code> must connect to <code>festivald</code> over <code>HTTPS</code> or <a href="tor.html"><code>.onion</code></a> if authorization is enabled or <code>festival-cli</code> will refuse to start.</p>
<h2 id="syntax"><a class="header" href="#syntax">Syntax</a></h2>
<p>The username &amp; password syntax is specified <a href="https://en.wikipedia.org/wiki/Basic_access_authentication">here</a>.</p>
<p>The &quot;authorization&quot; value must be:</p>
Expand Down
4 changes: 2 additions & 2 deletions cli/mdbook/docs/command-line.html
Original file line number Diff line number Diff line change
Expand Up @@ -170,8 +170,8 @@ <h1 class="menu-title">festival-cli v1.0.0</h1>
<div id="content" class="content">
<main>
<h1 id="command-line"><a class="header" href="#command-line">Command Line</a></h1>
<p>Arguments passed to <code>festival-cli</code> will always take priority over the same <a href="../config.html">configuration</a> options read from disk.</p>
<p>See <a href="/json-rpc.html"><code>JSON-RPC</code></a> for method command-line syntax.</p>
<p>Arguments passed to <code>festival-cli</code> will always take priority over the same <a href="config.html">configuration</a> options read from disk.</p>
<p>See <a href="json-rpc.html"><code>JSON-RPC</code></a> for method command-line syntax.</p>
<pre><code class="language-plaintext">Usage: festival-cli [--OPTIONS] &lt;METHOD&gt; [--PARAM &lt;VALUE&gt;]

Arguments passed to `festival-cli` will always take
Expand Down
4 changes: 2 additions & 2 deletions cli/mdbook/docs/config.html
Original file line number Diff line number Diff line change
Expand Up @@ -171,8 +171,8 @@ <h1 class="menu-title">festival-cli v1.0.0</h1>
<main>
<h1 id="config"><a class="header" href="#config">Config</a></h1>
<p><code>festival-cli</code> reads and loads its configuration file, <code>festival-cli.toml</code>, on startup. It controls various behaviors of <code>festival-cli</code>.</p>
<p>Exactly where this file is depends on the OS, more details in the <a href="/disk.html"><code>Disk</code></a> section.</p>
<p><a href="/command-line/command-line.html"><code>Command Line</code></a> flags will override any overlapping config values.</p>
<p>Exactly where this file is depends on the OS, more details in the <a href="disk.html"><code>Disk</code></a> section.</p>
<p><a href="command-line.html"><code>Command Line</code></a> flags will override any overlapping config values.</p>
<h2 id="festival-clitoml"><a class="header" href="#festival-clitoml"><code>festival-cli.toml</code></a></h2>
<p>This is the default configuration file <code>festival-cli</code> creates and uses.</p>
<p>If <code>festival-cli</code> is started with no <code>--flags</code>, e.g:</p>
Expand Down
4 changes: 2 additions & 2 deletions cli/mdbook/docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -180,8 +180,8 @@ <h1 id="intro"><a class="header" href="#intro">Intro</a></h1>
</code></pre>
<p>The typical invocation of <code>festival-cli</code>:</p>
<ol>
<li>Reads the <a href="/config.html">config</a> file</li>
<li>Reads the <a href="/command-line.html">command-line</a> options</li>
<li>Reads the <a href="config.html">config</a> file</li>
<li>Reads the <a href="command-line.html">command-line</a> options</li>
<li>Connects and sends a request to <code>festivald</code></li>
<li>Prints out the <code>JSON</code> response</li>
</ol>
Expand Down
4 changes: 2 additions & 2 deletions cli/mdbook/docs/intro.html
Original file line number Diff line number Diff line change
Expand Up @@ -180,8 +180,8 @@ <h1 id="intro"><a class="header" href="#intro">Intro</a></h1>
</code></pre>
<p>The typical invocation of <code>festival-cli</code>:</p>
<ol>
<li>Reads the <a href="/config.html">config</a> file</li>
<li>Reads the <a href="/command-line.html">command-line</a> options</li>
<li>Reads the <a href="config.html">config</a> file</li>
<li>Reads the <a href="command-line.html">command-line</a> options</li>
<li>Connects and sends a request to <code>festivald</code></li>
<li>Prints out the <code>JSON</code> response</li>
</ol>
Expand Down
14 changes: 7 additions & 7 deletions cli/mdbook/docs/print.html
Original file line number Diff line number Diff line change
Expand Up @@ -181,8 +181,8 @@ <h1 id="intro"><a class="header" href="#intro">Intro</a></h1>
</code></pre>
<p>The typical invocation of <code>festival-cli</code>:</p>
<ol>
<li>Reads the <a href="/config.html">config</a> file</li>
<li>Reads the <a href="/command-line.html">command-line</a> options</li>
<li>Reads the <a href="config.html">config</a> file</li>
<li>Reads the <a href="command-line.html">command-line</a> options</li>
<li>Connects and sends a request to <code>festivald</code></li>
<li>Prints out the <code>JSON</code> response</li>
</ol>
Expand Down Expand Up @@ -240,8 +240,8 @@ <h2 id="data"><a class="header" href="#data">Data</a></h2>
</code></pre>
<div style="break-before: page; page-break-before: always;"></div><h1 id="config-1"><a class="header" href="#config-1">Config</a></h1>
<p><code>festival-cli</code> reads and loads its configuration file, <code>festival-cli.toml</code>, on startup. It controls various behaviors of <code>festival-cli</code>.</p>
<p>Exactly where this file is depends on the OS, more details in the <a href="/disk.html"><code>Disk</code></a> section.</p>
<p><a href="/command-line/command-line.html"><code>Command Line</code></a> flags will override any overlapping config values.</p>
<p>Exactly where this file is depends on the OS, more details in the <a href="disk.html"><code>Disk</code></a> section.</p>
<p><a href="command-line.html"><code>Command Line</code></a> flags will override any overlapping config values.</p>
<h2 id="festival-clitoml"><a class="header" href="#festival-clitoml"><code>festival-cli.toml</code></a></h2>
<p>This is the default configuration file <code>festival-cli</code> creates and uses.</p>
<p>If <code>festival-cli</code> is started with no <code>--flags</code>, e.g:</p>
Expand Down Expand Up @@ -373,8 +373,8 @@ <h2 id="festival-clitoml"><a class="header" href="#festival-clitoml"><code>festi
confirm_no_tls_auth = false
</code></pre>
<div style="break-before: page; page-break-before: always;"></div><h1 id="command-line"><a class="header" href="#command-line">Command Line</a></h1>
<p>Arguments passed to <code>festival-cli</code> will always take priority over the same <a href="../config.html">configuration</a> options read from disk.</p>
<p>See <a href="/json-rpc.html"><code>JSON-RPC</code></a> for method command-line syntax.</p>
<p>Arguments passed to <code>festival-cli</code> will always take priority over the same <a href="config.html">configuration</a> options read from disk.</p>
<p>See <a href="json-rpc.html"><code>JSON-RPC</code></a> for method command-line syntax.</p>
<pre><code class="language-plaintext">Usage: festival-cli [--OPTIONS] &lt;METHOD&gt; [--PARAM &lt;VALUE&gt;]

Arguments passed to `festival-cli` will always take
Expand Down Expand Up @@ -611,7 +611,7 @@ <h2 id="festival-clitoml"><a class="header" href="#festival-clitoml"><code>festi
<div style="break-before: page; page-break-before: always;"></div><h1 id="authorization"><a class="header" href="#authorization">Authorization</a></h1>
<p><code>festivald</code> has a <a href="https://en.wikipedia.org/wiki/Basic_access_authentication"><code>Basic access authentication</code></a> option, with a username + password setup.</p>
<p>If enabled, <code>festival-cli</code> must also use <code>--authorization</code> or setup the <a href="config.html"><code>authorization</code></a> config option to connect to it.</p>
<p><code>festival-cli</code> must connect to <code>festivald</code> over <code>HTTPS</code> or <a href="/tor.html"><code>.onion</code></a> if authorization is enabled or <code>festival-cli</code> will refuse to start.</p>
<p><code>festival-cli</code> must connect to <code>festivald</code> over <code>HTTPS</code> or <a href="tor.html"><code>.onion</code></a> if authorization is enabled or <code>festival-cli</code> will refuse to start.</p>
<h2 id="syntax"><a class="header" href="#syntax">Syntax</a></h2>
<p>The username &amp; password syntax is specified <a href="https://en.wikipedia.org/wiki/Basic_access_authentication">here</a>.</p>
<p>The &quot;authorization&quot; value must be:</p>
Expand Down
2 changes: 1 addition & 1 deletion cli/mdbook/src/authorization.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

If enabled, `festival-cli` must also use `--authorization` or setup the [`authorization`](config.md) config option to connect to it.

`festival-cli` must connect to `festivald` over `HTTPS` or [`.onion`](/tor.md) if authorization is enabled or `festival-cli` will refuse to start.
`festival-cli` must connect to `festivald` over `HTTPS` or [`.onion`](tor.md) if authorization is enabled or `festival-cli` will refuse to start.

## Syntax
The username & password syntax is specified [here](https://en.wikipedia.org/wiki/Basic_access_authentication).
Expand Down
4 changes: 2 additions & 2 deletions cli/mdbook/src/command-line.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Command Line
Arguments passed to `festival-cli` will always take priority over the same [configuration](../config.md) options read from disk.
Arguments passed to `festival-cli` will always take priority over the same [configuration](config.md) options read from disk.

See [`JSON-RPC`](/json-rpc.md) for method command-line syntax.
See [`JSON-RPC`](json-rpc.md) for method command-line syntax.

```plaintext
{{#include ../../CMD.txt}}
Expand Down
4 changes: 2 additions & 2 deletions cli/mdbook/src/config.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Config
`festival-cli` reads and loads its configuration file, `festival-cli.toml`, on startup. It controls various behaviors of `festival-cli`.

Exactly where this file is depends on the OS, more details in the [`Disk`](/disk.md) section.
Exactly where this file is depends on the OS, more details in the [`Disk`](disk.md) section.

[`Command Line`](/command-line/command-line.md) flags will override any overlapping config values.
[`Command Line`](command-line.md) flags will override any overlapping config values.

## `festival-cli.toml`
This is the default configuration file `festival-cli` creates and uses.
Expand Down
4 changes: 2 additions & 2 deletions cli/mdbook/src/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ festival-cli collection_new
```

The typical invocation of `festival-cli`:
1. Reads the [config](/config.md) file
2. Reads the [command-line](/command-line.md) options
1. Reads the [config](config.md) file
2. Reads the [command-line](command-line.md) options
3. Connects and sends a request to `festivald`
4. Prints out the `JSON` response

Expand Down
4 changes: 2 additions & 2 deletions daemon/mdbook/docs/api-stability/api-stability.html
Original file line number Diff line number Diff line change
Expand Up @@ -172,9 +172,9 @@ <h1 class="menu-title">festivald v1.0.0</h1>
<h1 id="api-stability"><a class="header" href="#api-stability">API Stability</a></h1>
<p>Some notes on what parts of <code>festivald</code>'s API can/cannot be relied upon.</p>
<p>In general - <strong>things may be added, but never removed.</strong></p>
<p>If something is unstable, it will be <a href="/api-stability/marker.html"><code>marked</code></a> as such.</p>
<p>If something is unstable, it will be <a href="marker.html"><code>marked</code></a> as such.</p>
<h2 id="breaking-changes"><a class="header" href="#breaking-changes">Breaking Changes</a></h2>
<p>Breaking changes to the <a href="/api-stability/marker.html"><code>stable</code></a> API may occur in 3 situations:</p>
<p>Breaking changes to the <a href="marker.html"><code>stable</code></a> API may occur in 3 situations:</p>
<ol>
<li><code>festivald v2.0.0</code> release</li>
<li>There is a fundamental/security bug that must be fixed in <code>festivald</code></li>
Expand Down
6 changes: 3 additions & 3 deletions daemon/mdbook/docs/api-stability/json-rpc.html
Original file line number Diff line number Diff line change
Expand Up @@ -170,10 +170,10 @@ <h1 class="menu-title">festivald v1.0.0</h1>
<div id="content" class="content">
<main>
<h1 id="json-rpc"><a class="header" href="#json-rpc">JSON-RPC</a></h1>
<p><a href="/json-rpc/json-rpc.html"><code>JSON-RPC</code></a>-specific API stability notes.</p>
<p><a href="../json-rpc/json-rpc.html"><code>JSON-RPC</code></a>-specific API stability notes.</p>
<h3 id="ordering"><a class="header" href="#ordering">Ordering</a></h3>
<p>The ordering of <a href="/api-stability/marker.html">non-stable</a> output/object fields is <a href="/api-stability/marker.html"><code>πŸ”΄ Unstable</code></a>.</p>
<p>The ordering of <a href="/api-stability/marker.html"><code>🟒 Stable</code></a> output/object fields is <a href="/api-stability/marker.html"><code>🟒 Stable</code></a>.</p>
<p>The ordering of <a href="marker.html">non-stable</a> output/object fields is <a href="marker.html"><code>πŸ”΄ Unstable</code></a>.</p>
<p>The ordering of <a href="marker.html"><code>🟒 Stable</code></a> output/object fields is <a href="marker.html"><code>🟒 Stable</code></a>.</p>
<p>Old <code>v1.0.0</code> JSON-RPC example:</p>
<pre><code class="language-json">// 🟑 Incomplete Response
{
Expand Down
2 changes: 1 addition & 1 deletion daemon/mdbook/docs/api-stability/marker.html
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ <h1 class="menu-title">festivald v1.0.0</h1>
<div id="content" class="content">
<main>
<h1 id="marker"><a class="header" href="#marker">Marker</a></h1>
<p>In the documentation for all <a href="/common-objects/common-objects.html"><code>Objects</code></a>, <a href="/json-rpc/json-rpc.html"><code>JSON-RPC</code> methods</a>, and <a href="/rest/rest.html"><code>REST</code> endpoints</a> there will be a &quot;marker&quot; defining the stability of that API. It will be 1 of the 4 listed markers here.</p>
<p>In the documentation for all <a href="../common-objects/common-objects.html"><code>Objects</code></a>, <a href="../json-rpc/json-rpc.html"><code>JSON-RPC</code> methods</a>, and <a href="../rest/rest.html"><code>REST</code> endpoints</a> there will be a &quot;marker&quot; defining the stability of that API. It will be 1 of the 4 listed markers here.</p>
<h2 id="-stable"><a class="header" href="#-stable">🟒 Stable</a></h2>
<p>This marks that this API's input/output will never change, and can be relied upon.</p>
<h2 id="-incomplete"><a class="header" href="#-incomplete">🟑 Incomplete</a></h2>
Expand Down
Loading

0 comments on commit 4ee34f5

Please sign in to comment.