Skip to content

docs: fix validation findings #185

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tupe12334 merged 1 commit into from
Jul 23, 2026
Merged

docs: fix validation findings #185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions Installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
1 change: 1 addition & 0 deletions core/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<T>` alias |
| `validate` | `validate_checklists` — checks all `config.toml`/`flow.mmd` pairs under a checklists dir, used by `steplock validate` |

## Entry point

Expand Down
Loading