Skip to content

Commit 975f484

Browse files
committed
docs: comprehensive refresh for v0.1.550 and RustAPI Cloud split
- Sync version pins to 0.1.550 across README, docs hub, cookbook, and crate guides - Add Production Baseline, Production Checklist, and RustAPI Cloud cookbook recipe - Expand cargo-rustapi CLI reference (login, deploy cloud, deploy status) - Update RELEASES/CHANGELOG for post-split layout; remove personal deploy hostnames - Fix UTF-8 mojibake in docs; remove tracked agent-tools build logs
1 parent da55b30 commit 975f484

67 files changed

Lines changed: 1045 additions & 3458 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.gitignore

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@ assets/b9c93c1cd427d8f50e68dbd11ed2b000.jpg
2121
docs/cookbook/book/
2222
build_rs_cov.profraw
2323
answer.md
24-
docs/PRODUCTION_BASELINE.md
25-
docs/PRODUCTION_CHECKLIST.md
24+
2625
/.github/instructions
2726
/.github/prompts
2827
/.github/skills
@@ -35,6 +34,8 @@ docs/PRODUCTION_CHECKLIST.md
3534
!docs/PHILOSOPHY.md
3635
!docs/PERFORMANCE_BENCHMARKS.md
3736
!docs/native_openapi.md
37+
!docs/PRODUCTION_BASELINE.md
38+
!docs/PRODUCTION_CHECKLIST.md
3839
!docs/cookbook/src/**/*.md
3940
tasks.md
4041
/mcps

CHANGELOG.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10+
### Documentation
11+
12+
- Comprehensive docs refresh: version sync to **0.1.550**, public [Production Baseline](docs/PRODUCTION_BASELINE.md) and [Production Checklist](docs/PRODUCTION_CHECKLIST.md), new [RustAPI Cloud cookbook recipe](docs/cookbook/src/recipes/rustapi_cloud.md), expanded `cargo-rustapi` reference, encoding fixes, and removal of personal deploy hostnames from release notes.
13+
1014
### Changed
1115

1216
- **RustAPI Cloud** moved to its own repository: [github.com/Tuntii/RustAPI-Cloud](https://github.com/Tuntii/RustAPI-Cloud). This repo is now framework + CLI only.
@@ -24,7 +28,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2428

2529
- Binary-safe multipart parsing in `rustapi-core`.
2630
- CLI deploy status HTTP client timeout.
27-
- Domain spelling and production defaults for `tunayinbayramharcligi.com` deploy host.
31+
- Cloud CLI default URL aligned to `https://api.rustapi.cloud`.
2832

2933
### Changed
3034

README.md

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ Current benchmark methodology and canonical published performance claims live in
172172

173173
```toml
174174
[dependencies]
175-
api = { package = "rustapi-rs", version = "0.1.537" }
175+
api = { package = "rustapi-rs", version = "0.1.550" }
176176
```
177177

178178
```rust
@@ -256,15 +256,30 @@ Features are organized into three namespaces:
256256

257257
Meta features: `core` (default), `protocol-all`, `extras-all`, `full`.
258258

259+
## RustAPI Cloud
260+
261+
Deploy to managed hosting from the CLI. The cloud **backend** lives in [RustAPI-Cloud](https://github.com/Tuntii/RustAPI-Cloud); this repo ships the framework and CLI client.
262+
263+
```bash
264+
cargo install cargo-rustapi
265+
cargo rustapi login
266+
cargo rustapi deploy cloud
267+
cargo rustapi deploy status <deploy-id>
268+
```
269+
270+
Default API: `https://api.rustapi.cloud`. Self-hosted operators can pass `--cloud-url` to point at their own backend.
271+
272+
Full guide: [docs/cookbook/src/recipes/rustapi_cloud.md](docs/cookbook/src/recipes/rustapi_cloud.md)
273+
259274
## Recent Changes
260275

261-
See [CHANGELOG.md](CHANGELOG.md) for full history. Highlights in **v0.1.537**:
276+
See [CHANGELOG.md](CHANGELOG.md) for full history. Highlights in **v0.1.550**:
262277

263-
- **Maintainability (#201):** `app/builder.rs` split into `routing`, `openapi`, `health`, and `run` modules; all `src/**/*.rs` under 50KB
264-
- **Run lifecycle:** consistent `on_shutdown` hooks across all `run*` entrypoints
265-
- **RustAPI Cloud CLI** (`cargo rustapi login`, `deploy cloud`) in v0.1.528
278+
- **RustAPI Cloud CLI:** `deploy cloud`, `deploy status`, device-code `login`, `RUSTAPI_CONFIG_PATH` for isolated credentials
279+
- **Repo split:** cloud backend moved to [RustAPI-Cloud](https://github.com/Tuntii/RustAPI-Cloud); this repo is framework + CLI only
280+
- **OpenAPI modifiers:** `Multipart` / `Headers` `OperationModifier` for deploy and upload routes
281+
- **v0.1.537 maintainability:** `builder.rs` module split (#201), consistent `on_shutdown` across all `run*` entrypoints
266282
- **Native MCP:** in-process tools, `cargo rustapi mcp generate`, stdio transport
267-
- **Embedded dashboard** with replay browser and execution-path visualization
268283

269284
## Documentation
270285

@@ -273,8 +288,10 @@ See [CHANGELOG.md](CHANGELOG.md) for full history. Highlights in **v0.1.537**:
273288
| Docs hub | [docs/README.md](docs/README.md) |
274289
| Cookbook | [docs/cookbook/src/SUMMARY.md](docs/cookbook/src/SUMMARY.md) |
275290
| Getting started | [docs/GETTING_STARTED.md](docs/GETTING_STARTED.md) |
276-
| Community & contributing | [docs/COMMUNITY.md](docs/COMMUNITY.md) |
291+
| RustAPI Cloud | [docs/cookbook/src/recipes/rustapi_cloud.md](docs/cookbook/src/recipes/rustapi_cloud.md) |
292+
| Production baseline | [docs/PRODUCTION_BASELINE.md](docs/PRODUCTION_BASELINE.md) |
277293
| Production checklist | [docs/PRODUCTION_CHECKLIST.md](docs/PRODUCTION_CHECKLIST.md) |
294+
| Community & contributing | [docs/COMMUNITY.md](docs/COMMUNITY.md) |
278295
| API reference | [docs.rs/rustapi-rs](https://docs.rs/rustapi-rs) |
279296

280297
**Examples:** in-repo [`crates/rustapi-rs/examples/`](crates/rustapi-rs/examples/) and the separate **[rustapi-rs-examples](https://github.com/Tuntii/rustapi-rs-examples)** repository.

RELEASES.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,24 @@
77

88
## Highlights
99

10-
v0.1.550 ships the **first production-ready RustAPI Cloud stack** alongside framework/CLI fixes for managed deploys.
10+
v0.1.550 ships the **first production-ready RustAPI Cloud CLI integration** alongside framework fixes for managed deploys.
1111

1212
| Area | Change |
1313
|------|--------|
14-
| RustAPI Cloud | Vendored in monorepo (`RustAPI-Cloud/`, workspace-excluded); deploy pipeline, OAuth, storage, nginx wildcard routing |
15-
| Public deploy URLs | `https://{project}-{user8}.rustapi.tunayinbayramharcligi.com` |
14+
| RustAPI Cloud backend | [Tuntii/RustAPI-Cloud](https://github.com/Tuntii/RustAPI-Cloud) deploy pipeline, OAuth, storage, nginx wildcard routing |
15+
| Public deploy URLs | `https://{project}-{user8}.rustapi.{domain}` (managed default domain: `rustapi.cloud`) |
1616
| CLI | `cargo rustapi deploy status`, `RUSTAPI_CONFIG_PATH`, multipart/Headers OpenAPI modifiers |
17-
| Production defaults | Cloud port `3002`, Postgres `127.0.0.1:5435`, wildcard TLS nginx template |
17+
| Default cloud API | `https://api.rustapi.cloud` (override with `--cloud-url` for self-hosted backends) |
1818

1919
**Deploy flow:**
2020

2121
```bash
22-
cargo rustapi login --cloud-url https://rustapi.tunayinbayramharcligi.com
22+
cargo rustapi login
2323
cargo rustapi deploy cloud
24-
cargo rustapi deploy status
24+
cargo rustapi deploy status <deploy-id>
2525
```
2626

27-
**Repo layout:** RustAPI Cloud now lives in **[Tuntii/RustAPI-Cloud](https://github.com/Tuntii/RustAPI-Cloud)** (split after this release).
27+
**Repo layout:** This repository is **framework + CLI only**. Cloud backend development continues in **[RustAPI-Cloud](https://github.com/Tuntii/RustAPI-Cloud)**.
2828

2929
---
3030

0 commit comments

Comments
 (0)