feat: add docs crate (#48)

* feat: add docs crate

* docs(templates): add readme

* ci: remove extra waits

.github/workflows/main.yml

@@ -169,6 +169,31 @@ jobs:
             dependencies.stellation-core.registry dry-run > /tmp/tempfile-cargo1
           cat /tmp/tempfile-cargo1 > crates/stctl/Cargo.toml
 
+          toml set \
+            crates/stellation/Cargo.toml \
+            dependencies.stellation-core.registry dry-run > /tmp/tempfile-cargo1
+          cat /tmp/tempfile-cargo1 > crates/stellation/Cargo.toml
+
+          toml set \
+            crates/stellation/Cargo.toml \
+            dependencies.stellation-bridge.registry dry-run > /tmp/tempfile-cargo1
+          cat /tmp/tempfile-cargo1 > crates/stellation/Cargo.toml
+
+          toml set \
+            crates/stellation/Cargo.toml \
+            dependencies.stellation-frontend.registry dry-run > /tmp/tempfile-cargo1
+          cat /tmp/tempfile-cargo1 > crates/stellation/Cargo.toml
+
+          toml set \
+            crates/stellation/Cargo.toml \
+            dependencies.stellation-backend.registry dry-run > /tmp/tempfile-cargo1
+          cat /tmp/tempfile-cargo1 > crates/stellation/Cargo.toml
+
+          toml set \
+            crates/stellation/Cargo.toml \
+            dependencies.stctl.registry dry-run > /tmp/tempfile-cargo1
+          cat /tmp/tempfile-cargo1 > crates/stellation/Cargo.toml
+
           git commit -a -m "chore: switch to dry-run registry"
 
       - name: Prepare crates.io Registry
@@ -237,6 +262,19 @@ jobs:
         env:
           RUSTFLAGS: "--cfg releasing"
 
+      - name: Wait for Registry to Refresh
+        run: sleep 30s
+        shell: bash
+
+      - name: Run cargo publish for stellation
+        if: "!startsWith(github.ref, 'refs/tags/')"
+        run: |
+          cargo publish \
+            ${{ env.CARGO_PUBLISH_EXTRA_ARGS }} \
+            --manifest-path crates/stellation/Cargo.toml
+        env:
+          RUSTFLAGS: "--cfg releasing"
+
   publish-templates:
     name: Publish Templates
     runs-on: ubuntu-latest

README.md

@@ -1,4 +1,4 @@
-# stellation
+# Stellation
 
 A framework experience for Yew.
 

ci/feature-soundness.sh

@@ -17,5 +17,7 @@ cargo clippy -p stellation-frontend -- -D warnings
 
 cargo clippy -p stctl -- -D warnings
 
+cargo clippy -p stellation -- -D warnings
+
 cargo clippy -p example-fullstack-client -- -D warnings
 cargo clippy -p example-fullstack-server -- -D warnings

crates/stellation/Cargo.toml

@@ -0,0 +1,22 @@
+[package]
+name = "stellation"
+version = "0.1.0"
+edition = "2021"
+rust-version = "1.66"
+repository = "https://github.com/futursolo/stellation"
+authors = [
+    "Kaede Hoshiakwa <futursolo@icloud.com>",
+]
+description = "The framework experience for Yew."
+keywords = ["web", "wasm", "yew", "framework", "ssr"]
+categories = ["wasm", "web-programming"]
+readme = "../../README.md"
+homepage = "https://github.com/futursolo/stellation"
+license = "MIT OR Apache-2.0"
+
+[dependencies]
+stellation-core = { version = "0.1.0", path = "../stellation-core" }
+stellation-frontend = { version = "0.1.0", path = "../stellation-frontend" }
+stellation-backend = { version = "0.1.0", path = "../stellation-backend" }
+stellation-bridge = { version = "0.1.0", path = "../stellation-bridge" }
+stctl = { version = "0.1.0", path = "../stctl" }

crates/stellation/src/lib.rs

@@ -0,0 +1,17 @@
+//! Framework experience for Yew.
+//!
+//! Stellation provides a Yew development stack with:
+//!
+//! 1. Tooling around Server-side Rendering Support.
+//! 2. An easy-to-use, SSR-transparent RPC Implementation.
+//! 3. A development server that automatically rebuild upon changes.
+//! 4. A single binary distribution with embedded frontend.
+//!
+//! # Components
+//!
+//! 1. [stellation-frontend](stellation_frontend): The frontend application.
+//! 2. [stellation-backend](stellation_backend): The backend server.
+//! 3. [stellation-bridge](stellation_bridge): The bridge that provides communication between
+//!   frontend and backend.
+//! 4. [stctl]: Command line utility for building and serving development
+//! server.

templates/README.md

@@ -0,0 +1,7 @@
+# Stellation Templates
+
+To create a stellation project from one of the templates, use the following command:
+
+```bash
+  $ cargo generate --git https://github.com/stellation-templates
+```