Link to the 'next' docs by default

koto-lang · Dec 16, 2024 · 762b4e2 · 762b4e2
1 parent 089d1d5
commit 762b4e2
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 60 deletions.
diff --git a/website/templates/header.html b/website/templates/header.html
@@ -1,6 +1,3 @@
-{% set docs_info = load_data(path="content/docs/info.toml") %}
-{% set latest = docs_info["latest"] %}
-
 <div uk-sticky="sel-target: .uk-navbar-container cls-active: uk-navbar-sticky">
   <nav class="navbar uk-navbar-container uk-navbar">
 
@@ -25,7 +22,7 @@
         </li>
 
         <li>
-          <a class="uk-navbar-item uk-text-capitalize" href="/docs/{{latest}}">
+          <a class="uk-navbar-item uk-text-capitalize" href="/docs/next">
             Docs
           </a>
         </li>
@@ -58,4 +55,4 @@
       </ul>
     </div>
   </nav>
-</div>
+</div>
diff --git a/website/templates/index.html b/website/templates/index.html
@@ -13,16 +13,10 @@
     </div>
 
     <div class="uk-padding">
-      <a
-        class="uk-button uk-button-default uk-button-large 
-               uk-text-capitalize"
-        href="/about/"
-      >About</a>
-      <a
-        class="uk-button uk-button-default uk-button-large 
-               uk-text-capitalize"
-        href="/docs/{{docs_info["latest"]}}/language/"
-      >Guide</a>
+      <a class="uk-button uk-button-default uk-button-large
+               uk-text-capitalize" href="/about/">About</a>
+      <a class="uk-button uk-button-default uk-button-large
+               uk-text-capitalize" href="/docs/next/language/">Guide</a>
     </div>
 
     <div class="uk-container uk-width-1-2">
@@ -33,4 +27,4 @@
   </div>
 </section>
 
-{% endblock content %}
+{% endblock content %}
diff --git a/website/xtask/src/convert_docs.rs b/website/xtask/src/convert_docs.rs
@@ -8,8 +8,6 @@ use std::{
     path::{Path, PathBuf},
 };
 
-use crate::docs_info::DocsInfo;
-
 pub fn run() -> Result<()> {
     convert_single_page_doc(
         "about.md",
@@ -21,7 +19,7 @@ insert_anchor_links = "heading"
 "#,
         true,
         false,
-        FixUrlMode::TopLevelToLatest,
+        FixUrlMode::TopLevelToNext,
     )?;
     convert_single_page_doc(
         "language_guide.md",
@@ -172,8 +170,8 @@ struct ConvertDocFlags {
 
 #[derive(Copy, Clone)]
 enum FixUrlMode {
-    // Adjust doc links to docs/latest
-    TopLevelToLatest,
+    // Adjust doc links to docs/next
+    TopLevelToNext,
     // Adjust doc links to neighboring docs version
     TopLevel,
     // Adjust doc links to neighboring docs version from docs subfolder
@@ -323,14 +321,11 @@ fn fix_doc_urls(url: &str, mode: FixUrlMode) -> Result<String> {
     use FixUrlMode::*;
 
     let result = match mode {
-        TopLevelToLatest => {
-            let docs_info = DocsInfo::get_info();
-            let latest = &docs_info.latest;
-            url.replace("./language_guide.md", &format!("/docs/{latest}/language/"))
-                .replace("./cli.md", &format!("/docs/{latest}/cli/"))
-                .replace("./api.md", &format!("/docs/{latest}/api/"))
-                .replace("./core_lib", &format!("/docs/{latest}/core/"))
-        }
+        TopLevelToNext => url
+            .replace("./language_guide.md", &format!("/docs/next/language/"))
+            .replace("./cli.md", &format!("/docs/next/cli/"))
+            .replace("./api.md", &format!("/docs/next/api/"))
+            .replace("./core_lib", &format!("/docs/next/core/")),
         TopLevel => url
             .replace("./core_lib", "../core")
             .replace("./language_guide.md", "../language/"),

diff --git a/website/xtask/src/docs_info.rs b/website/xtask/src/docs_info.rs
@@ -4,13 +4,3 @@ use serde::{Deserialize, Serialize};
 pub struct DocsInfo {
     pub latest: String,
 }
-
-impl DocsInfo {
-    pub fn get_info() -> Self {
-        let info = include_str!(concat!(
-            env!("CARGO_MANIFEST_DIR"),
-            "/../content/docs/info.toml"
-        ));
-        toml::from_str(info).unwrap()
-    }
-}
diff --git a/website/xtask/src/postprocess_playground.rs b/website/xtask/src/postprocess_playground.rs
@@ -1,13 +1,14 @@
 use anyhow::{Context, Result};
 use std::{fs, io::Write, path::PathBuf};
 
-use crate::docs_info::DocsInfo;
-
 pub fn run(staging_dir: &str) -> Result<()> {
     let index_path: PathBuf = [staging_dir, "index.html"].iter().collect();
 
     let index = fs::read_to_string(&index_path).context("Failed to read index.html")?;
-    let header = get_header()?;
+    let header = include_str!(concat!(
+        env!("CARGO_MANIFEST_DIR"),
+        "/../templates/header.html"
+    ));
     let mobile_nav = concat!(
         include_str!(concat!(
             env!("CARGO_MANIFEST_DIR"),
@@ -32,21 +33,3 @@ pub fn run(staging_dir: &str) -> Result<()> {
 
     Ok(())
 }
-
-fn get_header() -> Result<String> {
-    // The header is a Zola template, but the playground isn't rendered with Zola,
-    // so it needs to be patched manually.
-    let header_template = include_str!(concat!(
-        env!("CARGO_MANIFEST_DIR"),
-        "/../templates/header.html"
-    ));
-    let latest = DocsInfo::get_info().latest;
-    let mut result = String::with_capacity(header_template.len());
-    for line in header_template.lines() {
-        if line.starts_with("{%") {
-            continue;
-        }
-        result.push_str(&line.replace(r"{{latest}}", &latest));
-    }
-    Ok(result)
-}