Skip to content

Commit 5ac9fbf

Browse files
committed
docs: open-source hub, community guide, and version sync
- Add docs/COMMUNITY.md for contributors and support channels - Restructure docs/README.md as documentation hub - README: community section, v0.1.537, dedupe quick-start - Sync snippet versions and MSRV (1.85) across docs/cookbook - CONTRIBUTING: documentation contribution guide
1 parent e86500e commit 5ac9fbf

82 files changed

Lines changed: 544 additions & 521 deletions

Some content is hidden

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

CONTRIBUTING.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ New to open source? Check out these resources:
7171

7272
### Prerequisites
7373

74-
- **Rust 1.75 or later** - Install from [rustup.rs](https://rustup.rs/)
74+
- **Rust 1.85 or later (MSRV)** - Install from [rustup.rs](https://rustup.rs/)
7575
- **Git** - For version control
7676
- **Code editor** - VS Code with rust-analyzer recommended
7777

@@ -467,11 +467,26 @@ RustAPI follows [Semantic Versioning](https://semver.org/):
467467
8. Publish crates: `./scripts/publish.ps1` or `./scripts/smart_publish.ps1`
468468
9. Create GitHub release with changelog
469469

470+
## Documentation Contributions
471+
472+
Documentation is part of the public product. When you change behavior, update the matching guide:
473+
474+
| Change type | Update |
475+
|-------------|--------|
476+
| User-facing API or feature | Cookbook recipe or `docs/` guide + `CHANGELOG.md` |
477+
| Internal refactor only | `CHANGELOG.md` under **Changed** / **Fixed** if user-visible |
478+
| New example | `crates/rustapi-rs/examples/` + examples README |
479+
| Contributor workflow | `CONTRIBUTING.md` or [docs/COMMUNITY.md](docs/COMMUNITY.md) |
480+
481+
Entry points for readers: [docs/README.md](docs/README.md) (hub), [docs/COMMUNITY.md](docs/COMMUNITY.md) (open source), [Cookbook SUMMARY](docs/cookbook/src/SUMMARY.md).
482+
483+
Run `cargo doc -p rustapi-rs --all-features` locally when you touch public types.
484+
470485
## Getting Help
471486

472487
### Resources
473488

474-
- 📖 **Documentation**: [docs/](docs/)
489+
- 📖 **Documentation**: [docs/](docs/) · [Community guide](docs/COMMUNITY.md)
475490
- 💬 **Discussions**: [GitHub Discussions](https://github.com/Tuntii/RustAPI/discussions)
476491
- 🐛 **Issues**: [GitHub Issues](https://github.com/Tuntii/RustAPI/issues)
477492
- 📧 **Contact**: Open an issue for questions

README.md

Lines changed: 25 additions & 52 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.507" }
175+
api = { package = "rustapi-rs", version = "0.1.537" }
176176
```
177177

178178
```rust
@@ -203,7 +203,7 @@ run_rustapi_and_mcp_with_shutdown(app, "0.0.0.0:8080", mcp, "0.0.0.0:9090", toki
203203

204204
Every tagged endpoint becomes an AI agent tool instantly.
205205

206-
> **Tip:** Crate'i `api` (veya `myapi`, `server` vs.) diye alias'lamak en temiz ve FastAPI benzeri deneyimi verir. Makrolar otomatik olarak `#[api::get]`, `#[api::post]`, `#[api::main]` şeklinde çalışır.
206+
> **Tip:** Alias the crate as `api` (or `myapi`, `server`, etc.) for clean `#[api::get]` / `#[api::main]` macros — similar to FastAPI's import style.
207207
208208
For production deployments, you can enable standard probe endpoints without writing handlers manually:
209209

@@ -244,29 +244,6 @@ async fn main() -> std::result::Result<(), Box<dyn std::error::Error + Send + Sy
244244

245245
`production_defaults()` enables request IDs, tracing spans, and standard probe endpoints in one call.
246246

247-
### Using a shorter macro prefix (recommended)
248-
249-
`rustapi-rs` makrolarını `api::get`, `api::post`, `api::main` gibi kısa ve güzel isimlerle kullanmak için crate'i alias'layabilirsiniz:
250-
251-
```toml
252-
[dependencies]
253-
api = { package = "rustapi-rs", version = "0.1.507" }
254-
```
255-
256-
```rust
257-
use api::prelude::*;
258-
259-
#[api::get("/users")]
260-
async fn list_users() -> &'static str { "ok" }
261-
262-
#[api::main]
263-
async fn main() -> std::result::Result<(), Box<dyn std::error::Error + Send + Sync>> {
264-
RustApi::auto().run("127.0.0.1:8080").await
265-
}
266-
```
267-
268-
Bu, hem daha okunabilir hem de FastAPI benzeri bir deneyim sağlar. Makro genişletme sırasında crate ismi otomatik olarak algılanır (`proc-macro-crate` sayesinde).
269-
270247
## Feature Flags
271248

272249
Features are organized into three namespaces:
@@ -281,40 +258,36 @@ Meta features: `core` (default), `protocol-all`, `extras-all`, `full`.
281258

282259
## Recent Changes
283260

284-
- **Crate consolidation (13 → 9):** `rustapi-testing`, `rustapi-jobs`, `rustapi-view`, and `rustapi-toon` merged into `rustapi-core` and `rustapi-extras` as feature-gated modules.
285-
- **Embedded Isometric System Dashboard:** Live `/dashboard` with bento-grid layout, execution-flow visualization, and time-travel replay browser.
286-
- **Native MCP (full featured):** In-process invocation (~28µs per call), `cargo rustapi mcp generate` for any OpenAPI spec, stdio transport, and improved cookbook coverage.
287-
- Dual-stack runtime: simultaneous HTTP/1.1 (TCP) and HTTP/3 (QUIC/UDP)
288-
- WebSocket permessage-deflate compression
289-
- `rustapi-grpc` crate: optional Tonic/Prost-based gRPC alongside HTTP (`run_rustapi_and_grpc`)
261+
See [CHANGELOG.md](CHANGELOG.md) for full history. Highlights in **v0.1.537**:
290262

291-
## Roadmap — v0.1.507 (shipped June 2026)
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
266+
- **Native MCP:** in-process tools, `cargo rustapi mcp generate`, stdio transport
267+
- **Embedded dashboard** with replay browser and execution-path visualization
292268

293-
- [x] Embedded Isometric System Dashboard (`/dashboard`)
294-
- Built-in control plane that boots automatically with a bento-grid layout, dark mode, and glassmorphism styling.
295-
- Live architectural view of request routing across the **Ultra Fast**, **Fast**, and **Full** execution paths.
296-
- Interactive endpoint visualization for topology inspection, route grouping, and runtime status awareness.
297-
- Time-travel replay UI for browsing recorded HTTP traffic, selecting a historical request, and inspecting replay state directly from the dashboard.
298-
- [x] Native MCP (Model Context Protocol) Orchestration
299-
- Embedded MCP server + `rustapi mcp generate` CLI turns any OpenAPI 3.x spec into agent tools.
300-
- In-process invocation path: ~28 µs per call (vs ~1.3 ms for localhost proxy with live server) for 1000 sequential calls.
301-
- stdio transport for desktop clients (Claude Desktop etc.).
302-
- Tag/path-prefix filtering, full pipeline respect (or zero-copy in-process when co-located).
303-
- Cookbook recipes for native use, CLI generator, in-process mode, and stdio.
269+
## Documentation
304270

271+
| Resource | Link |
272+
|----------|------|
273+
| Docs hub | [docs/README.md](docs/README.md) |
274+
| Cookbook | [docs/cookbook/src/SUMMARY.md](docs/cookbook/src/SUMMARY.md) |
275+
| Getting started | [docs/GETTING_STARTED.md](docs/GETTING_STARTED.md) |
276+
| Community & contributing | [docs/COMMUNITY.md](docs/COMMUNITY.md) |
277+
| Production checklist | [docs/PRODUCTION_CHECKLIST.md](docs/PRODUCTION_CHECKLIST.md) |
278+
| API reference | [docs.rs/rustapi-rs](https://docs.rs/rustapi-rs) |
305279

306-
## Documentation
280+
**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.
307281

308-
Detailed architecture, recipes, and guides are in the [Cookbook](docs/cookbook/src/SUMMARY.md):
282+
## Community & Contributing
309283

310-
- [System Architecture](docs/cookbook/src/architecture/system_overview.md)
311-
- [Performance Benchmarks](docs/cookbook/src/concepts/performance.md)
312-
- [gRPC Integration Guide](docs/cookbook/src/crates/rustapi_grpc.md)
313-
- [Recommended Production Baseline](docs/PRODUCTION_BASELINE.md)
314-
- [Production Checklist](docs/PRODUCTION_CHECKLIST.md)
315-
- [Internal Examples](crates/rustapi-rs/examples/)
284+
RustAPI is built in the open. Bug reports, docs fixes, recipes, and code contributions are welcome.
316285

317-
**Full standalone examples** (including a complete MCP tool example with in-process invocation) live in the separate **[rustapi-rs-examples](https://github.com/Tuntii/rustapi-rs-examples)** repository.
286+
- [Contributing guide](CONTRIBUTING.md) — setup, tests, PR workflow
287+
- [Community guide](docs/COMMUNITY.md) — channels, good-first issues, doc locations
288+
- [Code of Conduct](CODE_OF_CONDUCT.md)
289+
- [Security policy](SECURITY.md)
290+
- [GitHub Discussions](https://github.com/Tuntii/RustAPI/discussions) — questions and ideas
318291

319292
---
320293

RELEASES.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
1+
# RustAPI v0.1.537 Release Notes
2+
3+
**Release Date**: June 23, 2026
4+
**Full Changelog**: https://github.com/Tuntii/RustAPI/compare/v0.1.528...v0.1.537
5+
6+
---
7+
8+
## Highlights
9+
10+
v0.1.537 completes the **issue #201 maintainability pass**: `app/builder.rs` is split into focused internal modules while keeping the public `rustapi-rs` API unchanged.
11+
12+
| Area | Change |
13+
|------|--------|
14+
| App modules | `routing`, `openapi`, `health`, `run` — all `src/**/*.rs` under 50KB |
15+
| Run lifecycle | `on_shutdown` hooks run consistently on every `run*` entrypoint |
16+
| Tests | Router/extract bodies in `tests/support/*_lib.rs` via `include!` |
17+
| Public API | No breaking changes; `api/public` snapshots unchanged |
18+
19+
---
20+
121
# RustAPI v0.1.528 Release Notes
222

323
**Release Date**: June 22, 2026

0 commit comments

Comments
 (0)