From 981fea57ede1376cb7dd427d7ec0c2b62c172a95 Mon Sep 17 00:00:00 2001 From: Ian Renton Date: Wed, 23 Sep 2026 21:42:22 +0100 Subject: [PATCH] Rationalise docs part 5 #151 --- static/apidocs/openapi.yml | 2 +- templates/{add_spot.html => add-spot.html} | 2 +- templates/alerts.html | 2 +- templates/bands.html | 4 +- templates/base.html | 10 +- templates/conditions.html | 2 +- templates/{help/index.html => help.html} | 23 +- templates/help/usage.html | 49 ++++ templates/help/usage/clients.html | 71 +++--- templates/help/usage/docker.html | 52 ++-- templates/help/usage/embedding.html | 284 +++++++++++---------- templates/help/usage/modifying.html | 79 +++--- templates/help/usage/multicluster.html | 49 ++-- templates/help/usage/nginx.html | 61 ++--- templates/help/usage/running.html | 46 ++-- templates/help/usage/systemd.html | 12 +- templates/help/usage/telnet.html | 22 ++ templates/help/using.html | 45 ---- templates/map.html | 4 +- templates/spots.html | 4 +- templates/status.html | 2 +- webserver/webserver.py | 109 +++----- 22 files changed, 494 insertions(+), 440 deletions(-) rename templates/{add_spot.html => add-spot.html} (98%) rename templates/{help/index.html => help.html} (63%) create mode 100644 templates/help/usage.html create mode 100644 templates/help/usage/telnet.html delete mode 100644 templates/help/using.html diff --git a/static/apidocs/openapi.yml b/static/apidocs/openapi.yml index 8d38dcd..5b8dee9 100644 --- a/static/apidocs/openapi.yml +++ b/static/apidocs/openapi.yml @@ -5,7 +5,7 @@ info: description: |- Spothole is a utility to aggregate "spots" from amateur radio DX clusters and xOTA spotting sites, and provide an open JSON API as well as a website to browse the data. This page is an OpenAPI specification which describes Spothole's API. Clients can use this API to retrieve all the spots, alerts, and other information known to Spothole. - You can find out more information about Spothole at https://spothole.app/help. + You can find out more information about Spothole at https://spothole.app/help, and specifically about creating a client to this API at https://spothole.app/help/usage/clients. The API provided by https://spothole.app is provided free of charge, and no authentication is required. By using it, you accept the following: * You wrote the client code yourself, OR, if you got an AI to write it for you, you promise to read and understand what it wrote before contacting me about any problems. diff --git a/templates/add_spot.html b/templates/add-spot.html similarity index 98% rename from templates/add_spot.html rename to templates/add-spot.html index 7cacf17..7f09588 100644 --- a/templates/add_spot.html +++ b/templates/add-spot.html @@ -77,7 +77,7 @@ - + diff --git a/templates/alerts.html b/templates/alerts.html index 5e4cdbf..c608906 100644 --- a/templates/alerts.html +++ b/templates/alerts.html @@ -85,7 +85,7 @@ - + diff --git a/templates/bands.html b/templates/bands.html index d1402f1..e3626ea 100644 --- a/templates/bands.html +++ b/templates/bands.html @@ -76,8 +76,8 @@ - - + + diff --git a/templates/base.html b/templates/base.html index 680c970..0f53d1d 100644 --- a/templates/base.html +++ b/templates/base.html @@ -1,6 +1,6 @@ {% extends "skeleton.html" %} {% block head_extra %} - + @@ -16,10 +16,10 @@ window.fetchEventSource = fetchEventSource; - - - - + + + + {% end %} {% block body %}
diff --git a/templates/conditions.html b/templates/conditions.html index 7e04679..1b4f98e 100644 --- a/templates/conditions.html +++ b/templates/conditions.html @@ -284,7 +284,7 @@
- + diff --git a/templates/help/index.html b/templates/help.html similarity index 63% rename from templates/help/index.html rename to templates/help.html index 48be834..e4a4e04 100644 --- a/templates/help/index.html +++ b/templates/help.html @@ -1,25 +1,30 @@ -{% extends "../base.html" %} +{% extends "base.html" %} {% block content %}
+

Help and Information

Welcome to Spothole's help pages.

Spothole is a utility to aggregate spots from amateur radio DX clusters and xOTA spotting sites, and provide an - open JSON API as well as a website to browse the data.

+ open JSON API as well as a website to browse the data. (If that sounds like nonsense to you, I recommend + starting with the FAQ!)

In the sections below, you can find more information about what Spothole is, and how to use it.

- - + + diff --git a/templates/status.html b/templates/status.html index ca05cd7..bc88281 100644 --- a/templates/status.html +++ b/templates/status.html @@ -96,7 +96,7 @@ - +