Skip to content

Commit fb32139

Browse files
committed
Improve landing page
1 parent 5b63779 commit fb32139

File tree

1 file changed

+27
-4
lines changed

1 file changed

+27
-4
lines changed

src/lib.rs

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,27 @@
11
//! # Restate Rust SDK
22
//!
3-
//! [Restate](https://restate.dev/) is a system for easily building resilient applications using _distributed durable async/await_.
3+
//! [Restate](https://restate.dev/) is a system for easily building resilient applications.
44
//! This crate is the Restate SDK for writing Restate services using Rust.
55
//!
6+
//! ## New to Restate?
7+
//!
8+
//! If you are new to Restate, we recommend the following resources:
9+
//!
10+
//! - [Learn about the concepts of Restate](https://docs.restate.dev/concepts/durable_building_blocks)
11+
//! - Use cases:
12+
//! - [Workflows](https://docs.restate.dev/use-cases/workflows)
13+
//! - [Microservice orchestration](https://docs.restate.dev/use-cases/microservice-orchestration)
14+
//! - [Event processing](https://docs.restate.dev/use-cases/event-processing)
15+
//! - [Async tasks](https://docs.restate.dev/use-cases/async-tasks)
16+
//! - [Quickstart](https://docs.restate.dev/get_started/quickstart?sdk=rust)
17+
//! - [Do the Tour of Restate to try out the APIs](https://docs.restate.dev/get_started/tour/?sdk=rust)
18+
//!
19+
//! # SDK Overview
20+
//!
21+
//! The Restate Rust SDK lets you implement durable handlers. Handlers can be part of three types of services:
22+
//!
23+
//! Let's have a look at how to define them.
24+
//!
625
//! ```rust,no_run
726
//! // The prelude contains all the imports you need to get started
827
//! use restate_sdk::prelude::*;
@@ -34,7 +53,8 @@
3453
//! }
3554
//! ```
3655
//!
37-
//! You can define three types of services:
56+
//! ## Service types
57+
//! Learn more about each service type:
3858
//! - [Service](restate_sdk_macros::service)
3959
//! - [Virtual Object](object)
4060
//! - [Workflow](workflow)
@@ -53,16 +73,19 @@
5373
//! - [Serving][crate::http_server]: Start an HTTP server to expose services.
5474
//!
5575
//!
56-
//! # Logging
76+
//! ### Logging
5777
//!
5878
//! You can set the logging level of the Rust SDK via the `RESTATE_LOGGING` environment variable and the level values can be `TRACE`, `DEBUG`, `INFO`, `WARN` or `ERROR`.
59-
//!
6079
//! The default log level is `INFO`.
6180
//!
6281
//! If you set the level to `TRACE`, you can also get more verbose logging of the journal by setting the environment variable `RESTATE_JOURNAL_LOGGING=TRACE`.
6382
//!
83+
//! # References
6484
//!
6585
//! For a general overview about Restate, check out the [Restate documentation](https://docs.restate.dev).
86+
//!
87+
//! You can find more Rust examples in the [examples repo](https://github.com/restatedev/examples)
88+
//!
6689
6790
pub mod endpoint;
6891
pub mod service;

0 commit comments

Comments
 (0)