Move doc pages under /docs/* (#139)

* Move doc pages under /docs/* * Fix workflows
sycamore-rs · Jul 2, 2021 · 7e67e39 · 7e67e39
1 parent 1a2dd0e
commit 7e67e39
Show file tree

Hide file tree

Showing 7 changed files with 29 additions and 29 deletions.
diff --git a/.github/workflows/build_website.yml b/.github/workflows/build_website.yml
@@ -50,7 +50,7 @@ jobs:
       - name: Build examples
         run: |
           output="$(pwd)/docs/dist"
-          mkdir "$output/example"
+          mkdir "$output/examples"
           for path in examples/*; do
             if [[ ! -d $path ]]; then
               continue
@@ -59,7 +59,7 @@ jobs:
             echo "building: $example"
             (
               cd "$path"
-              dist_dir="$output/example/$example"
+              dist_dir="$output/examples/$example"
               mkdir "$dist_dir"
               trunk build --release --dist "$dist_dir" --public-url "/example/$example"
             )

diff --git a/.github/workflows/build_website_prod.yml b/.github/workflows/build_website_prod.yml
@@ -43,7 +43,7 @@ jobs:
       - name: Build examples
         run: |
           output="$(pwd)/docs/dist"
-          mkdir "$output/example"
+          mkdir "$output/examples"
           for path in examples/*; do
             if [[ ! -d $path ]]; then
               continue
@@ -52,7 +52,7 @@ jobs:
             echo "building: $example"
             (
               cd "$path"
-              dist_dir="$output/example/$example"
+              dist_dir="$output/examples/$example"
               mkdir "$dist_dir"
               trunk build --release --dist "$dist_dir" --public-url "/example/$example"
             )

diff --git a/docs/src/header.rs b/docs/src/header.rs
@@ -26,7 +26,7 @@ fn nav() -> Template<G> {
                 // Links section
                 div(class="flex flex-row ml-2 space-x-4 text-gray-600") {
                     a(class="py-2 px-3 text-sm hover:text-gray-800 hover:underline transition",
-                        href="/getting_started/installation",
+                        href="/docs/getting_started/installation",
                     ) {
                         "Book"
                     }

diff --git a/docs/src/index.rs b/docs/src/index.rs
@@ -12,7 +12,7 @@ pub fn index() -> Template<G> {
                 "Fast isomorphic web apps in Rust + WASM"
             }
             a(
-                href="/getting_started/installation",
+                href="/docs/getting_started/installation",
                 class="py-2 px-3 bg-white hover:bg-yellow-500 border-2 border-yellow-500 \
                 rounded font-medium transition",
             ) {

diff --git a/docs/src/main.rs b/docs/src/main.rs
@@ -10,7 +10,7 @@ use sycamore_router::{BrowserRouter, Route};
 enum Routes {
     #[to("/")]
     Index,
-    #[to("/<_>/<_>")]
+    #[to("/docs/<_>/<_>")]
     Docs(String, String),
     #[not_found]
     NotFound,

diff --git a/docs/src/sidebar.rs b/docs/src/sidebar.rs
@@ -4,46 +4,46 @@ static PAGES: &[(&str, &[(&str, &str)])] = &[
     (
         "Getting Started",
         &[
-            ("Installation", "/getting_started/installation"),
-            ("Hello World!", "/getting_started/hello_world"),
+            ("Installation", "getting_started/installation"),
+            ("Hello World!", "getting_started/hello_world"),
         ],
     ),
     (
         "Basics",
         &[
-            ("template!", "/basics/template"),
-            ("Reactivity", "/basics/reactivity"),
-            ("Components", "/basics/components"),
-            ("Control Flow", "/basics/control_flow"),
-            ("Iteration", "/basics/iteration"),
-            ("Data Binding", "/basics/data_binding"),
+            ("template!", "basics/template"),
+            ("Reactivity", "basics/reactivity"),
+            ("Components", "basics/components"),
+            ("Control Flow", "basics/control_flow"),
+            ("Iteration", "basics/iteration"),
+            ("Data Binding", "basics/data_binding"),
         ],
     ),
     (
         "Advanced Guides",
         &[
-            ("NodeRef", "/advanced/noderef"),
-            ("Tweened", "/advanced/tweened"),
-            ("Advanced Reactivity", "/advanced/advanced_reactivity"),
-            ("CSS", "/advanced/css"),
-            ("Testing", "/advanced/testing"),
-            ("Routing", "/advanced/routing"),
-            ("SSR", "/advanced/ssr"),
-            ("JS Interop", "/advanced/js_interop"),
+            ("NodeRef", "advanced/noderef"),
+            ("Tweened", "advanced/tweened"),
+            ("Advanced Reactivity", "advanced/advanced_reactivity"),
+            ("CSS", "advanced/css"),
+            ("Testing", "advanced/testing"),
+            ("Routing", "advanced/routing"),
+            ("SSR", "advanced/ssr"),
+            ("JS Interop", "advanced/js_interop"),
         ],
     ),
     (
         "Optimizations",
         &[
-            ("Code Size", "/optimizations/code_size"),
-            ("Speed", "/optimizations/speed"),
+            ("Code Size", "optimizations/code_size"),
+            ("Speed", "optimizations/speed"),
         ],
     ),
     (
         "Contribute",
         &[
-            ("Architecture", "/contribute/architecture"),
-            ("Development", "/contribute/development"),
+            ("Architecture", "contribute/architecture"),
+            ("Development", "contribute/development"),
         ],
     ),
 ];
@@ -60,7 +60,7 @@ pub fn sidebar() -> Template<G> {
                     template! {
                         li {
                             a(
-                                href=page.1,
+                                href=format!("/docs/{}", page.1),
                                 class="pl-4 hover:bg-gray-300 w-full inline-block rounded transition",
                             ) {
                                 (page.0)

diff --git a/netlify.toml b/netlify.toml
@@ -1,5 +1,5 @@
 [[redirects]]
-from = "/*"
+from = "/docs/*"
 status = 200
 to = "/index.html"