8000 docs: audit findings — correct Rust MSRV (1.85 → 1.95) + drop stale note by adeelahmad · Pull Request #2 · adeelahmad/aloop · GitHub
[go: up one dir, main page]
Skip to content

docs: audit findings — correct Rust MSRV (1.85 → 1.95) + drop stale note #2

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

Closed
adeelahmad wants to merge 1 commit into from
Closed

docs: audit findings — correct Rust MSRV (1.85 → 1.95) + drop stale note #2

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
7 changes: 3 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ block the stop and feed the failure reason back to the supervisor.

```bash
# 1) Build + install the gate backends (ctx-symbols + md-db, both from source)
# requires a Rust toolchain >= 1.85 (rustup.rs or `brew install rust`)
# requires a Rust toolchain >= 1.95 (rustup.rs or `brew install rust`)
./plugin/tools/install.sh
# ensure ~/.local/bin (or ~/.cargo/bin) is on PATH

Expand Down Expand Up @@ -100,7 +100,7 @@ Full operator playbook: [`plugin/skills/agentic-agile/SKILL.md`](plugin/skills/a
|------|-----------|---------|---------|
| **ctx-symbols** | recommended | symbol uniqueness (`count==1`) + duplicate/orphan detection | `./plugin/tools/install.sh` (builds from `plugin/tools/ctx-symbols`) |
| **md-db** | recommended | validates `.md` artifacts against `plugin/schemas/*.kdl` | `./plugin/tools/install.sh` (builds from vendored `plugin/tools/md-db`, AGPL-3.0) |
| **Rust toolchain** | required to install | builds both backends; also runs the target repo's fmt/clippy/test/coverage matrix | rustup (>= 1.85) |
| **Rust toolchain** | required to install | builds both backends; also runs the target repo's fmt/clippy/test/coverage matrix | rustup (>= 1.95) |

Both backends are optional: absent → gates WARN and fall back to grep (never a false
block, never a silent pass). See [`plugin/README.md`](plugin/README.md) for the gate
Expand Down Expand Up @@ -174,8 +174,7 @@ make publish # pushes branch + tags
Plugin implemented for a **Rust** target; gate bodies verified offline (positive +
negative) against a sample one-story sprint. Before relying on it: smoke-test the
hook wiring in a live Claude Code session (CI runs `plugin validate` but not a live
session). Set the real `repository` URL in `plugin/.claude-plugin/plugin.json` when
you create the public repo.
session).

## License

Expand Down
4 changes: 2 additions & 2 deletions plugin/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ See `skills/agentic-agile/SKILL.md` for the full supervisor playbook and
|------|-----------|--------------|---------|
| **ctx-symbols** | recommended | symbol uniqueness (`count==1`) + duplicate/parallel/orphan detection for the scaffold & structural gates | built from `tools/ctx-symbols` (see below) |
| **md-db** | recommended | validates `.md` artifacts against `schemas/*.kdl` | built from vendored `tools/md-db` (AGPL-3.0; see below) |
| **Rust toolchain** | required to install | builds both backends + runs the target repo's `cargo fmt/clippy/test/coverage` matrix | rustup (>= 1.85) |
| **Rust toolchain** | required to install | builds both backends + runs the target repo's `cargo fmt/clippy/test/coverage` matrix | rustup (>= 1.95) |

Both backends are **optional**: if absent, the gates WARN and fall back to grep —
they never falsely block and never silently pass a real check. A run with WARNs has
Expand All @@ -31,7 +31,7 @@ they never falsely block and never silently pass a real check. A run with WARNs

```bash
./tools/install.sh # builds + installs ctx-symbols AND md-db to ~/.local/bin
# (both from source; needs a Rust toolchain >= 1.85)
# (both from source; needs a Rust toolchain >= 1.95)
# ensure ~/.local/bin (or ~/.cargo/bin) is on PATH
```

Expand Down
5 changes: 3 additions & 2 deletions plugin/tools/install.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
# md-db : built from vendored source in this repo (tools/md-db, AGPL-3.0).
#
# Both are built from source, so a working Rust toolchain is required:
# rustc/cargo >= 1.85 (the vendored md-db deps use the 2024 edition).
# rustc/cargo >= 1.95 (the vendored md-db's `kdl` dependency requires 1.95;
# ctx-symbols alone builds on older toolchains).
# macOS: brew install rust · any: https://rustup.rs
#
# Usage: ./plugin/tools/install.sh [BIN_DIR]
Expand All @@ -17,7 +18,7 @@ BIN_DIR="${1:-$HOME/.local/bin}"
mkdir -p "$BIN_DIR"

command -v cargo >/dev/null 2>&1 || {
echo "ERROR: cargo not found. Install Rust (>=1.85): https://rustup.rs or 'brew install rust'." >&2
echo "ERROR: cargo not found. Install Rust (>=1.95): https://rustup.rs or 'brew install rust'." >&2
exit 1
}

Expand Down
Loading
0