aboutsummaryrefslogtreecommitdiff
path: root/docs/pages/1-getting-started.md
diff options
context:
space:
mode:
author魏曹先生 <1992414357@qq.com>2026-06-30 18:05:05 +0800
committer魏曹先生 <1992414357@qq.com>2026-06-30 18:05:05 +0800
commit13408e79b940e9a33ca593ed30d1b20c54e01234 (patch)
tree282549991a3f31791401ca2f3255b9318679d2e9 /docs/pages/1-getting-started.md
parent29867ab5c0b40378a33318d989c809f90fc7d3aa (diff)
feat(docs): add Chinese and English documentation for Mingling tutorials
Add comprehensive documentation covering Declare a Dispatcher, Declare a Chain, Rendering Results, Multi-Command Program, Argument Parsing with Picker and Clap, Program Setup, Error Handling, Help Info, Resource System, Exit Code Control, Hook System, Testing, Completion, Structural Rendering, and Core Concepts
Diffstat (limited to 'docs/pages/1-getting-started.md')
-rw-r--r--docs/pages/1-getting-started.md18
1 files changed, 9 insertions, 9 deletions
diff --git a/docs/pages/1-getting-started.md b/docs/pages/1-getting-started.md
index 5e746d3..c3527db 100644
--- a/docs/pages/1-getting-started.md
+++ b/docs/pages/1-getting-started.md
@@ -19,9 +19,9 @@ features = []
## Enable Features
-**Mingling** has all features disabled by default and does not provide an all-in-one feature like `full`.
+**Mingling** has all features disabled by default and does **not** provide an all-in-one feature like `full`.
-Some features will **directly affect the behavior of the entire lifecycle**, so you need to enable them as needed, for example:
+Some features **directly affect the entire lifecycle behavior**, so you need to enable them as needed, e.g.:
```toml
[dependencies.mingling]
@@ -33,11 +33,11 @@ features = [
```
> [!NOTE]
-> Visit [docs.rs](https://docs.rs/mingling/latest/mingling/feature/index.html) or [Features](pages/other/features) to learn about all available features.
+> Visit [docs.rs](https://docs.rs/mingling/latest/mingling/feature/index.html) or [Features](pages/other/features) to learn about all features.
## Write the Basic Entry Point
-Edit `src/main.rs` with the following code:
+Write the following code in `src/main.rs`:
```rust
use mingling::prelude::*;
@@ -52,13 +52,13 @@ gen_program!();
```
> [!IMPORTANT]
-> Almost all Rust code blocks in the documentation have been compiled through the CI pipeline and are guaranteed to be usable.
+> Almost all Rust code blocks in the docs have been compiled in CI and are guaranteed to work.
>
-> However, code blocks starting with `// NOT VERIFIED` have **not been verified**.
+> However, code blocks starting with `// NOT VERIFIED` are **not 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)
+> Want to know which `*.md` files are compiled? See [`verified-docs.toml`](https://github.com/mingling-rs/mingling/blob/main/verified-docs.toml).
-## Verify Compilation
+## Verify with Compilation
```plaintext
~# cargo check
@@ -66,4 +66,4 @@ gen_program!();
---
-Once everything is good, start building!
+Once everything is good, start writing something!