diff options
| author | 魏曹先生 <1992414357@qq.com> | 2026-06-21 18:33:32 +0800 |
|---|---|---|
| committer | 魏曹先生 <1992414357@qq.com> | 2026-06-21 18:33:32 +0800 |
| commit | 232f31c6649e6348a5b0b64362f185f7f4db1dc0 (patch) | |
| tree | 81784c32ff9ae75d0a27a0d0e7b7eb2d0aaf9bbe /docs/pages | |
| parent | 90f563d7bbcbea98ee966bfb62a3e4a942e19c64 (diff) | |
Add intro content and merge getting started page
Diffstat (limited to 'docs/pages')
| -rw-r--r-- | docs/pages/1-getting-started.md (renamed from docs/pages/2-getting-started.md) | 7 | ||||
| -rw-r--r-- | docs/pages/1-intro.md | 32 |
2 files changed, 7 insertions, 32 deletions
diff --git a/docs/pages/2-getting-started.md b/docs/pages/1-getting-started.md index 35da464..4832191 100644 --- a/docs/pages/2-getting-started.md +++ b/docs/pages/1-getting-started.md @@ -51,6 +51,13 @@ fn main() { gen_program!(); ``` +> [!IMPORTANT] +> Almost all Rust code blocks in the documentation have been compiled through the CI pipeline and are guaranteed to be usable. +> +> However, code blocks starting with `// NOT VERIFIED` have **not been verified**. +> +> Want to know which `*.md` files have been compiled? Check [`verified-docs.toml`](https://github.com/mingling-rs/mingling/blob/main/verified-docs.toml) + ## Verify Compilation ```plaintext diff --git a/docs/pages/1-intro.md b/docs/pages/1-intro.md deleted file mode 100644 index edf83bb..0000000 --- a/docs/pages/1-intro.md +++ /dev/null @@ -1,32 +0,0 @@ -<h1 align="center">Introduction</h1> - -If you're troubled by these issues — - -1. Too many subcommands make `main.rs` bloat rapidly; -2. Handler logic mixed with side effects; -3. Logging, auth, and other cross-cutting concerns are hard to inject non-invasively; -4. Maintaining shell completion scripts for multiple platforms wears you out; -5. Global resources everywhere, making testing difficult. - -… then you've come to the right place. - -Of course, if you're just curious about "how to write maintainable CLIs in Rust," you've also come to the right place — it'll be fun. - -## What is Mingling? - -> **Mìng Lìng** is the pinyin of the Chinese word **命令**, -> which translates to **Command** in English. - -Mingling is a CLI framework built with Rust. It's free, open-source, and licensed under the permissive MIT / Apache 2.0 license. - -Mingling's design goals: - -- **Extensible**: From 3 subcommands to 30, same pattern, no framework swap -- **Decoupled**: Parse args once, write business logic once, define output format once. Each independent. -- **Type-driven**: Clear, typed data flows through the pipeline — not `Vec<String>` -- **Lightweight deps**: Minimal core deps, low cost to pull in; advanced features on demand, no compile-time drag -- **Efficient**: Dispatch logic generated at compile time, no unnecessary runtime overhead - ---- - -Alright, wanna give it a try? |
