docs: add some comments on useful locations

crates/app/src/lib.rs

@@ -1,8 +1,7 @@
 use std::path::Path;
 
-use askama_axum::Template;
 use axum::http::{StatusCode, Uri};
-use axum_htmx::{AutoVaryLayer, HxRequest};
+use axum_htmx::AutoVaryLayer;
 use tower_http::services::ServeDir;
 
 mod menu;
@@ -12,21 +11,11 @@ async fn fallback(uri: Uri) -> (StatusCode, String) {
     (StatusCode::NOT_FOUND, format!("No route for {uri}"))
 }
 
-#[derive(Template)]
-#[template(path = "index.html")]
-pub struct GetIndexTemplate {
-    hx_request: bool,
-}
-
-async fn root(HxRequest(hx_request): HxRequest) -> GetIndexTemplate {
-    GetIndexTemplate { hx_request }
-}
-
 pub fn get_router(assets_path: &Path) -> axum::Router {
     axum::Router::new()
         .nest_service("/assets", ServeDir::new(assets_path))
-        .route("/", axum::routing::get(root))
         .merge(pages::get_routes())
         .fallback(fallback)
+        // The AutoVaryLayer is used to avoid cache issues with htmx (cf: https://github.com/robertwayne/axum-htmx?tab=readme-ov-file#auto-caching-management)
         .layer(AutoVaryLayer)
 }

crates/app/src/menu.rs

@@ -4,6 +4,9 @@ pub struct MenuItem {
     pub href: String,
 }
 
+/// Get the menu items
+/// This function is the central place to define the menu items
+/// It can be used directly in templates, for example in the `navbar` component to render the menu
 pub fn get_menu_items() -> Vec<MenuItem> {
     vec![
         MenuItem {

crates/app/src/pages/home.rs

@@ -0,0 +1,12 @@
+use askama_axum::Template;
+use axum_htmx::HxRequest;
+
+#[derive(Template)]
+#[template(path = "home.html")]
+pub struct GetHomeTemplate {
+    hx_request: bool,
+}
+
+pub async fn home(HxRequest(hx_request): HxRequest) -> GetHomeTemplate {
+    GetHomeTemplate { hx_request }
+}

crates/app/src/pages/mod.rs

@@ -1,7 +1,10 @@
 use axum::{routing, Router};
 
 mod cps;
+mod home;
 
 pub fn get_routes() -> Router {
-    Router::new().route("/cps", routing::get(cps::cps))
+    Router::new()
+        .route("/", axum::routing::get(home::home))
+        .route("/cps", routing::get(cps::cps))
 }