summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorOwen Jacobson <owen@grimoire.ca>2025-07-08 01:44:46 -0400
committerOwen Jacobson <owen@grimoire.ca>2025-07-08 01:55:36 -0400
commit64d16441a390e889231f2f67333d5f305b7ab878 (patch)
tree88d686ef194eada20fc0c157e681ed72971ecc3f /src
parent4eb0cc56696a3805538e5ce6d380ea26e097424c (diff)
Set up a skeleton for swatches.
A swatch is a live, and ideally editable, example of an element of the service. They serve as: * Documentation: what is this element, how do you use it, what does it do? * Demonstration: what does this element look like? * Manual test scaffolding: when I change this element like _so_, what happens? Swatches are collectively available under `/.swatch/` on a running instance, and are set up in a separate [group] from the rest of the UI. They do not require setup or login for simplicity's sake and because they don't _do_ anything that requires either of those things. [group]: https://svelte.dev/docs/kit/advanced-routing#Advanced-layouts-(group) Swatches are manually curated, for a couple of reasons: * We lack the technical infrastructure needed to do this based on static analysis; and * Manual curation lets us include affordances like "recommended values," that would be tricky to express as part of the type or schema for the component. The tradeoff, however, is that swatches may fall out of step with the components they depic, if not reviewed regularly. I hope that, by making them part of the development process, this risk will be mitigated through regular use.
Diffstat (limited to 'src')
-rw-r--r--src/routes.rs1
-rw-r--r--src/ui/handlers/mod.rs2
-rw-r--r--src/ui/handlers/swatch.rs8
3 files changed, 11 insertions, 0 deletions
diff --git a/src/routes.rs b/src/routes.rs
index 49d9fb6..6993070 100644
--- a/src/routes.rs
+++ b/src/routes.rs
@@ -10,6 +10,7 @@ pub fn routes(app: &App) -> Router<App> {
// UI routes that can be accessed before the administrator completes setup.
let ui_bootstrap = Router::new()
.route("/{*path}", get(ui::handlers::asset))
+ .route("/.swatch/{*path}", get(ui::handlers::swatch))
.route("/setup", get(ui::handlers::setup));
// UI routes that require the administrator to complete setup first.
diff --git a/src/ui/handlers/mod.rs b/src/ui/handlers/mod.rs
index ed0c14e..bcc65a1 100644
--- a/src/ui/handlers/mod.rs
+++ b/src/ui/handlers/mod.rs
@@ -5,6 +5,7 @@ mod invite;
mod login;
mod me;
mod setup;
+mod swatch;
pub use asset::handler as asset;
pub use conversation::handler as conversation;
@@ -13,3 +14,4 @@ pub use invite::handler as invite;
pub use login::handler as login;
pub use me::handler as me;
pub use setup::handler as setup;
+pub use swatch::handler as swatch;
diff --git a/src/ui/handlers/swatch.rs b/src/ui/handlers/swatch.rs
new file mode 100644
index 0000000..4562b04
--- /dev/null
+++ b/src/ui/handlers/swatch.rs
@@ -0,0 +1,8 @@
+use crate::{
+ error::Internal,
+ ui::assets::{Asset, Assets},
+};
+
+pub async fn handler() -> Result<Asset, Internal> {
+ Assets::index()
+}