Merge branch 'main' into feature-powerset-log-group

roadster-rs · Oct 20, 2024 · 9d1b849 · 9d1b849
2 parents 302c370 + d7b4d54
commit 9d1b849
Show file tree

Hide file tree

Showing 25 changed files with 196 additions and 60 deletions.
diff --git a/book/src/adding-a-ui/index.md b/book/src/adding-a-ui/index.md
@@ -1 +1,21 @@
-# Adding a UI
+# Adding a UI
+
+Currently, Roadster is focused on back-end API development with Rust. We leave it to the consumer to decide how they
+prefer to add a front-end, e.g., using an established JS/TS
+framework ([React](https://react.dev/) / [Next](https://nextjs.org/) / [Vue](https://vuejs.org/) / [Svelte](https://svelte.dev/) / [Solid](https://www.solidjs.com/)
+/ etc) or
+using a Rust front-end
+framework ([Leptos](https://github.com/leptos-rs/leptos) / [Yew](https://github.com/yewstack/yew) / [Perseus](https://github.com/framesurge/perseus/) / [Sycamore](https://github.com/sycamore-rs/sycamore)
+/ etc). That said, we do have some examples of how to use Roadster with some these frameworks.
+
+## Examples
+
+| Framework                                 | Example                                                                             |
+|:------------------------------------------|:------------------------------------------------------------------------------------|
+| [Leptos](https://crates.io/crates/leptos) | [leptos-ssr](https://github.com/roadster-rs/roadster/tree/main/examples/leptos-ssr) |
+
+<style>
+table {
+    min-width: 100%
+}
+</style>
diff --git a/book/src/comparisons/loco.md b/book/src/comparisons/loco.md
diff --git a/book/src/features/app-context.md b/book/src/features/app-context.md
@@ -1 +1,5 @@
 # App context
+
+See:
+
+- <https://docs.rs/roadster/latest/roadster/app/context/struct.AppContext.html>
diff --git a/book/src/features/auth/jwt.md b/book/src/features/auth/jwt.md
@@ -1 +1,5 @@
 # JWT
+
+See:
+
+- <https://docs.rs/roadster/latest/roadster/middleware/http/auth/jwt/index.html>
diff --git a/book/src/features/cli.md b/book/src/features/cli.md
@@ -1,5 +1,6 @@
 # CLI
 
-## Built-in commands
+See:
 
-## Custom commands
+- <https://docs.rs/roadster/latest/roadster/api/cli/trait.RunCommand.html>
+- <https://docs.rs/roadster/latest/roadster/api/cli/roadster/index.html>
diff --git a/book/src/features/configuration.md b/book/src/features/configuration.md
@@ -3,3 +3,8 @@
 <!--Todo: Mention Environment::Custom variant-->
 <!--Todo: Mention multiple file formats-->
 <!--Todo: Mention overriding via env vars-->
+
+See:
+
+- <https://docs.rs/roadster/latest/roadster/config/index.html>
+- <https://docs.rs/roadster/latest/roadster/config/struct.AppConfig.html>
diff --git a/book/src/features/database/index.md b/book/src/features/database/index.md
@@ -1 +1,8 @@
 # Database
+
+See:
+
+- <https://docs.rs/roadster/latest/roadster/migration/index.html>
+- <https://docs.rs/roadster/latest/roadster/migration/check/index.html>
+- <https://docs.rs/roadster/latest/roadster/migration/schema/index.html>
+- <https://docs.rs/roadster/latest/roadster/migration/uuid/index.html>
diff --git a/book/src/features/database/user.md b/book/src/features/database/user.md
@@ -1 +1,5 @@
 # User SQL migrations
+
+See:
+
+- <https://docs.rs/roadster/latest/roadster/migration/user/struct.UserMigrator.html>
diff --git a/book/src/features/database/utility-migrations.md b/book/src/features/database/utility-migrations.md
@@ -1 +1,5 @@
 # Utility SQL migrations
+
+See:
+
+- <https://docs.rs/roadster/latest/roadster/migration/timestamp/index.html>
diff --git a/book/src/features/email/index.md b/book/src/features/email/index.md
@@ -1 +1,5 @@
 # Email
+
+See:
+
+- <https://docs.rs/roadster/latest/roadster/config/email/index.html>
diff --git a/book/src/features/email/sendgrid.md b/book/src/features/email/sendgrid.md
@@ -1 +1,5 @@
 # Sendgrid
+
+See:
+
+- <https://docs.rs/roadster/latest/roadster/config/email/sendgrid/struct.Sendgrid.html>
diff --git a/book/src/features/email/smtp.md b/book/src/features/email/smtp.md
@@ -1 +1,5 @@
 # SMTP
+
+See:
+
+- <https://docs.rs/roadster/latest/roadster/config/email/smtp/index.html>
diff --git a/book/src/features/health.md b/book/src/features/health.md
@@ -1 +1,6 @@
 # Health checks
+
+See:
+
+- <https://docs.rs/roadster/latest/roadster/health_check/trait.HealthCheck.html>
+- <https://docs.rs/roadster/latest/roadster/config/health_check/struct.HealthCheck.html>
diff --git a/book/src/features/lifecycle.md b/book/src/features/lifecycle.md
@@ -1 +1,6 @@
 # Lifecycle hooks
+
+See:
+
+- <https://docs.rs/roadster/latest/roadster/lifecycle/trait.AppLifecycleHandler.html>
+
diff --git a/book/src/features/services/function.md b/book/src/features/services/function.md
@@ -1 +1,5 @@
 # Function service
+
+See:
+
+- <https://docs.rs/roadster/latest/roadster/service/function/service/struct.FunctionService.html>
diff --git a/book/src/features/services/grpc.md b/book/src/features/services/grpc.md
@@ -1 +1,5 @@
 # Grpc service with [Tonic](https://crates.io/crates/tonic)
+
+See:
+
+- <https://docs.rs/roadster/latest/roadster/service/grpc/service/struct.GrpcService.html>
diff --git a/book/src/features/services/http/index.md b/book/src/features/services/http/index.md
@@ -1 +1,5 @@
 # HTTP Service with [Axum](https://crates.io/crates/axum)
+
+See:
+
+- <https://docs.rs/roadster/latest/roadster/service/http/index.html>
diff --git a/book/src/features/services/http/initializer.md b/book/src/features/services/http/initializer.md
@@ -1 +1,6 @@
 # Initializers
+
+See:
+
+- <https://docs.rs/roadster/latest/roadster/service/http/initializer/index.html>
+
diff --git a/book/src/features/services/http/middleware.md b/book/src/features/services/http/middleware.md
@@ -1 +1,5 @@
 # Axum Middleware
+
+See:
+
+- <https://docs.rs/roadster/latest/roadster/service/http/middleware/index.html>
diff --git a/book/src/features/services/http/state.md b/book/src/features/services/http/state.md
@@ -1 +1,7 @@
 # Axum State
+
+See:
+
+- <https://docs.rs/roadster/latest/roadster/app/context/struct.AppContext.html>
+- <https://docs.rs/axum/latest/axum/extract/struct.State.html>
+- <https://docs.rs/axum/latest/axum/extract/trait.FromRef.html>
diff --git a/book/src/features/services/index.md b/book/src/features/services/index.md
@@ -1 +1,5 @@
 # Services
+
+See:
+
+- <https://docs.rs/roadster/latest/roadster/service/index.html>
diff --git a/book/src/features/testing.md b/book/src/features/testing.md
@@ -1 +1,5 @@
 # Testing
+
+See:
+
+- <https://docs.rs/roadster/latest/roadster/testing/snapshot/index.html>
diff --git a/book/src/features/tracing/index.md b/book/src/features/tracing/index.md
@@ -1 +1,6 @@
 # Tracing with Tokio's [tracing](https://crates.io/crates/tracing) crate
+
+See:
+
+- <https://docs.rs/roadster/latest/roadster/tracing/fn.init_tracing.html>
+- <https://docs.rs/roadster/latest/roadster/config/tracing/struct.Tracing.html>
diff --git a/book/src/features/tracing/otel.md b/book/src/features/tracing/otel.md
@@ -1 +1,6 @@
 # OpenTelemetry
+
+See:
+
+- <>
+- <https://docs.rs/tracing-opentelemetry/0.22.0/tracing_opentelemetry/>
diff --git a/book/src/getting-started/index.md b/book/src/getting-started/index.md
@@ -1 +1,9 @@
 # Getting started
+
+See our examples:
+
+- [Full](https://github.com/roadster-rs/roadster/tree/main/examples/full) - Demo of all features
+- [App builder](https://github.com/roadster-rs/roadster/tree/main/examples/app-builder) - Demo of the builder-style API
+  to configure the app
+- [Leptos SSR](https://github.com/roadster-rs/roadster/tree/main/examples/leptos-ssr) - Demo of using Leptos with
+  Roadster