From a4ce9c58026ed40b0da5073b37cc4c6582faa93f Mon Sep 17 00:00:00 2001 From: tupe12334 Date: Mon, 20 Jul 2026 09:07:54 +0300 Subject: [PATCH] docs: fix crates.io link and document validate/clean commands SECURITY.md pointed at a nonexistent steplock-core crate instead of steplock. Installation.md and core/README.md didn't mention the steplock validate / steplock clean subcommands or the validate module. --- Installation.md | 9 +++++++++ SECURITY.md | 2 +- core/README.md | 1 + 3 files changed, 11 insertions(+), 1 deletion(-) diff --git a/Installation.md b/Installation.md index 86b087c..f5157ba 100644 --- a/Installation.md +++ b/Installation.md @@ -174,6 +174,15 @@ cat .steplock/audit.log --- +## Other commands + +```sh +steplock validate # check every config.toml / flow.mmd under .steplock/checklists/ for errors +steplock clean # remove all session state under .steplock/sessions/ (checklists restart fresh) +``` + +--- + ## Editor support Add the schema hint to `config.toml` (already shown above) for [Taplo](https://taplo.tamasfe.dev) autocomplete and inline validation via the [Even Better TOML](https://marketplace.visualstudio.com/items?itemName=tamasfe.even-better-toml) VS Code extension. diff --git a/SECURITY.md b/SECURITY.md index 715d9fd..b255e9b 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -6,7 +6,7 @@ | ------- | --------- | | latest | ✅ | -Only the latest published version on [crates.io](https://crates.io/crates/steplock-core) receives security fixes. +Only the latest published version on [crates.io](https://crates.io/crates/steplock) receives security fixes. ## Reporting a Vulnerability diff --git a/core/README.md b/core/README.md index d333dc9..8ad6a53 100644 --- a/core/README.md +++ b/core/README.md @@ -14,6 +14,7 @@ Rust library implementing the steplock gate logic. Used by the `steplock` CLI bi | `scripts` | Writes `ack.sh` and `preview.sh` to the session directory | | `audit` | Appends JSONL events to `.steplock/audit.log` | | `error` | `SteplockError` enum and `Result` alias | +| `validate` | `validate_checklists` — checks all `config.toml`/`flow.mmd` pairs under a checklists dir, used by `steplock validate` | ## Entry point