Skip to content

docs: correct specification examples and runtime guidance - #231

Merged
mkovaxx merged 2 commits into
mainfrom
feat/agent-skill-corrected
Oct 17, 2026
Merged

mkovaxx merged 2 commits into
mainfrom
feat/agent-skill-corrected

Conversation

@MauScheff

@MauScheff MauScheff commented Oct 16, 2026 •

Copy link
Copy Markdown
Collaborator

The README's sample failure output does not match current runtime reporting, and several REFERENCE examples use outdated postcondition syntax or omit input bounds. This PR fixes those standalone documentation issues against current main.

  • Show how anodized_print and anodized_panic report failed conditions.
  • Distinguish capture evaluation in the default mode from separate specification embedding.
  • Bind returned values explicitly in postconditions and correct borrowing syntax.
  • Add input bounds to the implemented maximum-search and counter examples, while keeping syntax examples minimal with todo!() bodies.
  • Remove an unused import from the configuration example.

Only crates/anodized/README.md and crates/anodized/REFERENCE.md change. The agent skill, plugin manifests, Rust validation tooling, and CI additions remain in #193. No plugin installation instructions are included here.

Extracted from Slava (@rayslava)'s documentation work in #193, with follow-up corrections. Slava is credited as co-author.

Validation:

  • cargo test -p anodized --doc: 2 passed, 3 ignored.
  • All 13 REFERENCE Rust examples compiled with rustdoc --test against this checkout in default and anodized_panic modes.
  • cargo fmt --all -- --check: passed.
  • git diff --check: passed.

Extract standalone documentation improvements from #193.

Co-authored-by: Slava Barinov <rayslava@rayslava.com>
@MauScheff
MauScheff force-pushed the feat/agent-skill-corrected branch from 1d347b5 to fcdeb94 Compare October 16, 2026 11:22
@MauScheff MauScheff changed the title feat: ship the validated Anodized agent plugin docs: correct specification examples and runtime guidance Oct 16, 2026
Comment thread crates/anodized/REFERENCE.md Outdated
Comment thread crates/anodized/REFERENCE.md Outdated
Comment thread crates/anodized/REFERENCE.md Outdated
Comment thread crates/anodized/REFERENCE.md Outdated
Comment thread crates/anodized/REFERENCE.md Outdated
Comment thread crates/anodized/REFERENCE.md

@mkovaxx mkovaxx left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Just a few minor things, then it's good to go! Thanks! :)

@mkovaxx mkovaxx self-assigned this Oct 16, 2026
@mkovaxx
mkovaxx self-requested a review October 17, 2026 04:51

@mkovaxx mkovaxx left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks good, thanks! :)

@mkovaxx
mkovaxx merged commit cc7c32f into main Oct 17, 2026
15 checks passed
@mkovaxx
mkovaxx deleted the feat/agent-skill-corrected branch October 17, 2026 04:52
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.

2 participants