From b55a1c7afb8df0923272327b5417b1627324da54 Mon Sep 17 00:00:00 2001 From: Austen Adler Date: Sun, 12 Mar 2023 01:38:17 -0500 Subject: [PATCH] Publish docs alongside app --- docs/ALGORITHM.adoc | 2 +- docs/DESIGN.adoc | 2 +- docs/index.adoc | 7 +++---- justfile | 7 ++++--- web-frontend/.gitignore | 9 +++++---- web-frontend/package.json | 4 ++-- web-frontend/src/routes/+layout.svelte | 14 +++++--------- web-frontend/src/routes/docs/+page.svelte | 1 + 8 files changed, 22 insertions(+), 24 deletions(-) create mode 100644 web-frontend/src/routes/docs/+page.svelte diff --git a/docs/ALGORITHM.adoc b/docs/ALGORITHM.adoc index 94bc793..4c8fa84 100644 --- a/docs/ALGORITHM.adoc +++ b/docs/ALGORITHM.adoc @@ -12,7 +12,7 @@ The goal of this document is to define the algorithm. -If you want to see the steps to get to this definition, go to link:/docs/DESIGN[DESIGN]. +If you want to see the steps to get to this definition, go to link:/docs/DESIGN.html[DESIGN]. == Data format diff --git a/docs/DESIGN.adoc b/docs/DESIGN.adoc index 9080305..4cebe98 100644 --- a/docs/DESIGN.adoc +++ b/docs/DESIGN.adoc @@ -12,7 +12,7 @@ The goal of this document is to walk through how the design was chosen. -If you want to see the algorithm definition, go to link:/docs/ALGORITHM[ALGORITHM]. +If you want to see the algorithm definition, go to link:/docs/ALGORITHM.html[ALGORITHM]. == 10,000 meter view diff --git a/docs/index.adoc b/docs/index.adoc index 480e5ad..589b6ea 100644 --- a/docs/index.adoc +++ b/docs/index.adoc @@ -10,10 +10,9 @@ == Pages -* link:..[xpin.app] - Go back to the xpin homepage -* link:/docs/ALGORITHM[ALGORITHM] - Algorithm definition -* link:/docs/DESIGN[DESIGN] - Algorithm design documentation -* link:/docs/WORDLIST[WORDLIST] - Wordlist design and implementation +* link:/docs/ALGORITHM.html[ALGORITHM] - Algorithm definition +* link:/docs/DESIGN.html[DESIGN] - Algorithm design documentation +* link:/docs/WORDLIST.html[WORDLIST] - Wordlist design and implementation ++++