Skip to content

docs: add Installation, Architecture, Contributing nav links to README #11

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
Jun 11, 2026
Merged

docs: add Installation, Architecture, Contributing nav links to README #11

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
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

steplock sits on top of the [polyhook](https://github.com/tupe12334/polyhook) SDK. It intercepts hook events and gates actions behind a sequential checklist — one question per invocation, acknowledged by the agent, persisted to disk.

**[Installation →](Installation.md)** · **[Architecture →](Architecture.md)** · **[Contributing →](CONTRIBUTING.md)**

---

## The Problem
Expand Down Expand Up @@ -92,6 +94,10 @@ stateDiagram-v2
skip_reason : Describe why test coverage was skipped.
```

See [`examples/git-push-quality-gate/`](examples/git-push-quality-gate/) for a complete working example.

---

## Editor support

**`config.toml`** — add the `#:schema` hint. [Taplo](https://taplo.tamasfe.dev) (via [Even Better TOML](https://marketplace.visualstudio.com/items?itemName=tamasfe.even-better-toml)) provides autocomplete and inline validation.
Expand Down
Loading