Skip to content

docs(guides): add forge properties guide - #2130

Open
figtracer wants to merge 7 commits into
masterfrom
fig/forge-properties-docs
Open

figtracer wants to merge 7 commits into
masterfrom
fig/forge-properties-docs

Conversation

@figtracer

@figtracer figtracer commented Oct 6, 2026 •

Copy link
Copy Markdown
Member

Why

Before: the forge properties guide described an older agent workflow. It had no verifier, no sample verifier, and an out-of-date CLI reference.

After: the guide matches the current command: bring-your-own agents with a quorum, @bug tagged failing tests, grouped reports, an optional disprove-first verifier, and the execution protections.

Change

Rewrites guides/forge-properties.mdx for foundry-rs/foundry#17259, with a sample agent script and a sample verifier script. Regenerates reference/forge/properties.mdx from forge properties --help. Merge after the Foundry implementation lands.

Downstream

None. Docs only.

Explain how forge properties generates test properties with an external generator, how Forge decides to keep, report, or reject them, how to check a candidate, and the stateful handler convention.
@vercel

vercel Bot commented Oct 6, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
foundry-docs Ready Ready Preview Oct 25, 2026 4:30pm UTC

Request Review

@figtracer
figtracer marked this pull request as draft October 8, 2026 11:51
@figtracer
figtracer marked this pull request as ready for review October 14, 2026 18:25

@0xKarl98 0xKarl98 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Three review concerns against Book 6ab2c677, compared with the current implementation of foundry-rs/foundry#17259 at a6fb4fc9. All three remain applicable if the companion PR merges unchanged: the runnable command uses an obsolete option, the candidate schema excludes the audit fields, and the documented retention guarantees differ from the implementation.

Each inline comment includes implementation excerpts and links pinned to that commit. The schema conflict was reproduced locally against the companion PR's test candidate; CLI and retention behavior were checked against source and test expectations. I did not build or run the companion Rust tests.

Comment thread src/pages/guides/forge-properties.mdx Outdated
Comment thread src/pages/guides/forge-properties.mdx Outdated
@figtracer
figtracer marked this pull request as draft October 18, 2026 15:28
Align the guide with the current agent-session implementation in foundry-rs/foundry#17259. Replace the obsolete mutation rounds and candidate JSON protocol with the environment interface, seed validation, quorum reporting, output paths, and execution boundaries.
Describe the verifier command and verdicts, the grouping and report flow, the environment protections, and sample agent and verifier scripts. Regenerate the forge properties CLI reference from the current help.
@figtracer
figtracer marked this pull request as ready for review October 25, 2026 16:29

This branch was successfully deployed

1 active deployment
Preview — c0db7ce5 Deployed Oct 25, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants