Turn the index page of the documentation into a redirect to the user …

…guide. (#79) ## What Changed? Flips the index page of your documentation to a HTML that redirects to the user guide notion page. ## Why Does It Need To? This way we have a) a nicer landing page and also an easy-ish to remember link we can give people to the guide. ## Checklist - [x] Above description has been filled out so that upon quash merge we have a good record of what changed. - [x] New functions, methods, types are documented. Old documentation is updated if necessary - [x] Documentation in Notion has been updated - [x] Tests for new behaviors are provided - [x] New test suites (if any) ave been added to the CI tests (in `.github/workflows/rust.yml`) either as compiler test or integration test. *Or* justification for their omission from CI has been provided in this PR description. - [x] Remove the `"push"` trigger for the workflow after ensuring it works.
brownsys · Oct 10, 2023 · 64c1f52 · 64c1f52
1 parent 505cd31
commit 64c1f52
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 22 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -28,12 +28,10 @@ jobs:
         cp -R target/doc docs/libs
         rm -R .github
     - name: Copy Rustc Docs
-      run: |
-        cd doc-src && cargo run
-    - name: Build Index Page
-      uses: docker://pandoc/core
-      with:
-        args: "-s -o docs/index.html doc-src/index.md"
+      run: cargo run
+      working-directory: doc-src
+    - name: Copy index page
+      run: cp doc-src/index.html docs/index.html
     - name: Commit Doc Generation
       run: |
         git add docs

diff --git a/doc-src/index.html b/doc-src/index.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="refresh" content="0; url='https://www.notion.so/justus-adam/Paralegal-User-Guide-6e483e6ad03d4701bea245caf1345fcf?pvs=4'" />
+  </head>
+  <body>
+    <p>This URL is only used because it is easy to remember.</p>
+    <p> Paralegal's documentation is actually hosted at <a href="https://www.notion.so/justus-adam/Paralegal-User-Guide-6e483e6ad03d4701bea245caf1345fcf?pvs=4">https://manishearth.github.io/blog/2018/01/10/whats-tokio-and-async-io-all-about/</a> and you are being redirected there now.</p>
+    <p>Should the redirect fail you can also click the link.</p>
+  </body>
+</html>
diff --git a/doc-src/index.md b/doc-src/index.md