aboutsummaryrefslogtreecommitdiff
path: root/dev/ci/help.txt
diff options
context:
space:
mode:
author魏曹先生 <1992414357@qq.com>2026-08-19 05:54:00 +0800
committer魏曹先生 <1992414357@qq.com>2026-08-19 06:15:20 +0800
commitec9edc294fd5e7e29977fc7b0e6fb953422bc0e2 (patch)
treebbf89ef4457b8de8a8a9bca5668045d612d27572 /dev/ci/help.txt
parent06dfc27194c11e1d1033c292c759a1c5d82e780b (diff)
chore: reorganize dev tools into dev/ directory and consolidate configsHEADmain
Move CI, dev tools, and configs from root-level scattered locations into a unified `dev/` directory structure. Update all references across build scripts, documentation, and editor configurations. Also consolidate editor config generation into build.rs for automated synchronization of rust-analyzer settings across VS Code and Zed.
Diffstat (limited to 'dev/ci/help.txt')
-rw-r--r--dev/ci/help.txt34
1 files changed, 34 insertions, 0 deletions
diff --git a/dev/ci/help.txt b/dev/ci/help.txt
new file mode 100644
index 0000000..de006bb
--- /dev/null
+++ b/dev/ci/help.txt
@@ -0,0 +1,34 @@
+This program is used to check the code quality of the Mingling project itself.
+
+USAGE: cargo ci <FLAGS> [SUBCOMMAND] <ARGS...>
+
+FLAGS:
+ -h, --help Print this help page
+ -q, --quiet Quiet output
+
+COMMANDS:
+ UTILS:
+ report-collect Collect and organize all inspection reports
+ report-clean Clean up all reports
+
+ git-lock Temporarily commit the workspace for CI
+ git-unlock Restore the workspace after CI
+
+ show-features Print the docs.rs feature list of mingling
+ show-manifests Print all crate paths that need to be checked
+
+ TOOLS:
+ example-refresh Regenerate example docs module and examples index
+ docsify-refresh Fix docsify code boxes and regenerate sidebars
+ features-refresh Regenerate the features module
+
+ TASKS:
+ markdown-check <PATH> Verify rust code blocks in one markdown file
+ markdown-check-all Verify rust code blocks in all configured markdown files
+ markdown-compare <PATH> <PATH> Compare the structure of two markdown files/dirs
+ markdown-compare-all Compare all translated docs against the reference
+ build-check Build all crates
+ clippy-check Run clippy with -D warnings on all crates
+ test-all Test all crates
+ example-check Build examples and run their test.toml cases
+ docs-check Build mingling docs with -D warnings