Skip to content

Commit

Permalink
docs: add migration guide from v0.1 to v0.2 (#118)
Browse files Browse the repository at this point in the history
* docs: add migration guide from v0.1 to v0.2

* docs: update wording
  • Loading branch information
futursolo authored Jul 16, 2023
1 parent ee45664 commit b4d3f0f
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 0 deletions.
21 changes: 21 additions & 0 deletions crates/stellation/src/guides/migration_01_02.rs
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
9 changes: 9 additions & 0 deletions crates/stellation/src/guides/mod.rs
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;
2 changes: 2 additions & 0 deletions crates/stellation/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,5 @@
//! frontend and backend.
//! 4. [stctl]: Command line utility for building and serving development
//! server.
pub mod guides;

0 comments on commit b4d3f0f

Please sign in to comment.