New dev. idex

acterglobal · Aug 13, 2024 · bbc89a3 · bbc89a3
1 parent 6aa2fb4
commit bbc89a3
Show file tree

Hide file tree

Showing 4 changed files with 69 additions and 4 deletions.
diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml
@@ -39,17 +39,17 @@ jobs:
         run: |
           cargo doc -p acter -p acter-core -p matrix-sdk-store-media-cache-wrapper
           echo --- Moving docs
-          mv target/doc/ docs/static/api/main/rust
+          mv target/doc/ docs/api/main/rust
 
       - name: Build Dart App
-        run: flutter pub global run dartdoc  --include-external integration_test/main_test.dart --output ../docs/static/api/main/app/
+        run: flutter pub global run dartdoc  --include-external integration_test/main_test.dart --output ../docs/api/main/app/
         working-directory: app
 
       - name: Checking for bindings
         run: ls -ltas packages/rust_sdk/lib/
 
       - name: Build Dart SDK
-        run: flutter pub global run dartdoc --output ../../../docs/static/api/main/dart-sdk/
+        run: flutter pub global run dartdoc --output ../../../docs/api/main/dart-sdk/
         working-directory: packages/rust_sdk
 
       - name: Upload artifact

diff --git a/docs/.gitignore b/docs/.gitignore
@@ -1,2 +1,2 @@
-static/api/main/
+api/main/
 public
diff --git a/docs/static/api/main/.gitkeep → docs/api/main/.gitkeep b/docs/static/api/main/.gitkeep → docs/api/main/.gitkeep
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,65 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <meta http-equiv="X-UA-Compatible" content="chrome=1" />
+    <title>Acter Developer Docs</title>
+
+    <link rel="stylesheet" href="stylesheets/styles.css" />
+    <meta name="viewport" content="width=device-width" />
+  </head>
+  <body>
+    <div class="wrapper">
+      <header>
+        <h1>Acter</h1>
+        <p>organize your activism</p>
+        <p class="view">
+          <a href="http://github.com/acterglobal/a3"
+            >View the Project on GitHub <small>acterglobal/a3</small></a
+          >
+        </p>
+        <ul>
+          <li>
+            <a href="https://github.com/acterglobal/a3/zipball/master"
+              >Download <strong>ZIP File</strong></a
+            >
+          </li>
+          <li>
+            <a href="https://github.com/acterglobal/a3/tarball/master"
+              >Download <strong>TAR Ball</strong></a
+            >
+          </li>
+          <li>
+            <a href="http://github.com/acterglobal/a3"
+              >Fork On <strong>GitHub</strong></a
+            >
+          </li>
+        </ul>
+      </header>
+      <section>
+        <h1>
+          <a href="https://acter.global/dev/"
+            >Developer Documentation has moved</a
+          >
+          <ul>
+            <li>
+              🏗️
+              <a href="/api/main/dart-sdk/">SDK docs (main)</a><br />The
+              internal SDK and its types as dart docs
+            </li>
+            <li>
+              📱
+              <a href="/api/main/app/">App docs (main)</a><br />The full API
+              docs in Flutter for the entire app, including all custom Widget
+            </li>
+            <li>
+              🍄
+              <a href="/api/main/rust/acter/">Rust docs (main)</a><br />The API
+              docs of the internal SDK on the rust-level
+            </li>
+          </ul>
+        </h1>
+      </section>
+    </div>
+  </body>
+</html>