-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add migration guide from v0.1 to v0.2 (#118)
* docs: add migration guide from v0.1 to v0.2 * docs: update wording
- Loading branch information
Showing
3 changed files
with
32 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
//! Migration Guide from v0.1 to v0.2 | ||
//! | ||
//! # 1. `stellation-backend` crate has been separated into multiple crates. | ||
//! | ||
//! `stellation-backend` has been separated into multiple crates: | ||
//! | ||
//! 1. `stellation-backend`: contains server renderer and other utilities to build backends. | ||
//! 2. `stellation-backend-warp`: contains server that can be used as a warp filter. | ||
//! 3. `stellation-backend-tower`: contains server that can be used as a tower service. | ||
//! 4. `stellation-backend-cli`: contain out-of-the-box command line utility for backend | ||
//! applications. | ||
//! | ||
//! # 2. `stellation-bridge` has been rewritten. | ||
//! | ||
//! Previously, it uses feature flags to switch between local and remote bridges. | ||
//! This has been switched to a link based system. | ||
//! | ||
//! Since this is a complete rewrite, we recommend users to refer to the new [fullstack](https://github.com/futursolo/stellation/tree/main/examples/fullstack) example about | ||
//! how to use the new bridge. | ||
//! | ||
//! # 3. Bounce is updated to version v0.7 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
//! Guides and Tutorials | ||
//! | ||
//! This module contains various guides and tutorials for stellation. | ||
//! | ||
//! # Migration Guides | ||
//! | ||
//! 1. [v0.1 to v0.2](migration_01_02) | ||
pub mod migration_01_02; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters