From 3c0682a41f0601f587b7d38a96002fe140013f99 Mon Sep 17 00:00:00 2001 From: Jilles van Gurp Date: Wed, 1 Apr 2026 20:36:53 +0200 Subject: [PATCH] docs: simplify hub docs pages on website --- content/open-location-hub/docs/_index.md | 11 ++--------- content/open-location-hub/docs/architecture.md | 4 +--- content/open-location-hub/docs/auth.md | 2 -- content/open-location-hub/docs/configuration.md | 2 -- content/open-location-hub/docs/rpc.md | 2 -- 5 files changed, 3 insertions(+), 18 deletions(-) diff --git a/content/open-location-hub/docs/_index.md b/content/open-location-hub/docs/_index.md index b196ca1..e6288f2 100644 --- a/content/open-location-hub/docs/_index.md +++ b/content/open-location-hub/docs/_index.md @@ -1,16 +1,9 @@ --- title: "Software Documentation" -description: "Use the documents in this directory for software behavior, runtime configuration, and integration guidance." +description: "Reference documentation for hub architecture, configuration, authentication, and RPC behavior." draft: false generated: true generated_from: "docs/index.md" github_url: "https://github.com/Open-Location-Stack/open-location-hub/blob/main/docs/index.md" --- -_This page is generated from the Open Location Hub source documentation and should not be edited in the website repository._ - -Use the documents in this directory for software behavior, runtime configuration, and integration guidance. - -- `architecture.md`: system structure, processing flows, and trust boundaries -- `configuration.md`: environment variables and runtime tuning -- `auth.md`: JWT auth modes, authorization model, and permission file behavior -- `rpc.md`: REST-facing RPC usage and control-plane behavior +Reference documentation for hub architecture, configuration, authentication, and RPC behavior. diff --git a/content/open-location-hub/docs/architecture.md b/content/open-location-hub/docs/architecture.md index 884586a..4aa65a8 100644 --- a/content/open-location-hub/docs/architecture.md +++ b/content/open-location-hub/docs/architecture.md @@ -1,13 +1,11 @@ --- title: "Architecture" -description: "Generated documentation page for Architecture." +description: "System structure, processing flows, and trust boundaries." draft: false generated: true generated_from: "docs/architecture.md" github_url: "https://github.com/Open-Location-Stack/open-location-hub/blob/main/docs/architecture.md" --- -_This page is generated from the Open Location Hub source documentation and should not be edited in the website repository._ - ## Layers - `cmd/hub`: process bootstrap and wiring - `internal/config`: environment-driven configuration diff --git a/content/open-location-hub/docs/auth.md b/content/open-location-hub/docs/auth.md index bdeec1c..2c4495e 100644 --- a/content/open-location-hub/docs/auth.md +++ b/content/open-location-hub/docs/auth.md @@ -6,8 +6,6 @@ generated: true generated_from: "docs/auth.md" github_url: "https://github.com/Open-Location-Stack/open-location-hub/blob/main/docs/auth.md" --- -_This page is generated from the Open Location Hub source documentation and should not be edited in the website repository._ - This project supports standards-based JWT bearer authentication for the REST API and an authorization model built around JWT claims plus a server-side permissions file. The same token verifier is also used for the OMLOX WebSocket surface, but WebSocket authentication happens per message through `params.token` instead of the HTTP `Authorization` header. diff --git a/content/open-location-hub/docs/configuration.md b/content/open-location-hub/docs/configuration.md index 8ff44a5..083cf76 100644 --- a/content/open-location-hub/docs/configuration.md +++ b/content/open-location-hub/docs/configuration.md @@ -6,8 +6,6 @@ generated: true generated_from: "docs/configuration.md" github_url: "https://github.com/Open-Location-Stack/open-location-hub/blob/main/docs/configuration.md" --- -_This page is generated from the Open Location Hub source documentation and should not be edited in the website repository._ - All runtime configuration is environment-driven. Runtime lifecycle behavior: diff --git a/content/open-location-hub/docs/rpc.md b/content/open-location-hub/docs/rpc.md index d9e4af1..335c4a4 100644 --- a/content/open-location-hub/docs/rpc.md +++ b/content/open-location-hub/docs/rpc.md @@ -6,8 +6,6 @@ generated: true generated_from: "docs/rpc.md" github_url: "https://github.com/Open-Location-Stack/open-location-hub/blob/main/docs/rpc.md" --- -_This page is generated from the Open Location Hub source documentation and should not be edited in the website repository._ - ## What RPC is RPC is the hub's command and diagnostics interface.