Skip to content

docs: fix agent guide gaps from the evaluations - #86

Merged
cardmagic merged 3 commits into
mainfrom
docs/agent-guide-fixes
Oct 8, 2026
Merged

cardmagic merged 3 commits into
mainfrom
docs/agent-guide-fixes

Conversation

@cardmagic

Copy link
Copy Markdown
Owner

Why

The Track B (installed skill) and Track C (implementation) agent evaluations found answers and code that docs/agents.md did not prevent.

What changes

  • Current release: a Codex Track C attempt installed 0.14.2 from memory and read that release's docs. The install step now says to take the current release and links RubyGems.
  • Rails requirement: two Track B answers said "Rails 8.0+". The gem description now states "requires Ruby 3.3 or newer and Rails 7.1 or newer", and test/unit/gem_specification_test.rb asserts it.
  • API mistakes: agent code called reject with one argument, used id inside an actor, and called schedule without an operation. The guide shows reject(:room_full, "The room is full") and adds a table of these mistakes with the correct form. Loading the gem confirms that an actor defines actor_id and no id.
  • Authorization: the install step points to step 5, because the generated policies deny every call.

Validation

  • The new gemspec assertion failed before the description change (Expected /requires Ruby 3\.3 or newer and Rails 7\.1 or newer/ to match ...) and passes after it.
  • bundle exec rake: 873 runs, 0 failures, 28 database skips; Standard, RuboCop, RBS, Steep, and Brakeman are clean. One earlier run failed PostCommitTest#test_caller_cleanup_preserves_a_callback_record_lookup_error_and_its_original_cause with a 5 second SyncTimeout while the machine was loaded; this branch changes no runtime code, and the file passed 3 of 3 times alone and in the next full run.

The Track B and Track C agent evaluations found answers and code that
the guide did not prevent:

- A Codex attempt installed 0.14.2 from memory and read that old
  documentation. The install step now says to take the current release.
- Two answers said Rails 8.0+. The gem description now states Ruby 3.3
  and Rails 7.1, and a test asserts it.
- Agent code called reject with one argument, used id inside an actor,
  and called schedule without an operation. The guide now shows the two
  arguments of reject and lists these mistakes with the correct form.
  A Ruby actor defines actor_id and no id, which was checked by loading
  the gem.
- The install step now points to step 5, because the generated policies
  deny every call.
@greptile-apps

greptile-apps Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

RetriggerConfidence Score: 5/5

[Low risk] Documentation and version bump for agent guide clarifications.

The latest commit appears safe to merge; the release version changes agree.

What we checked:

  • Release versions agree: The gem specification and release checks read SolidObjects::VERSION. Both lockfile entries and the changelog match it.

Summary

The latest commit prepares release 0.17.2.

  • Updates SolidObjects::VERSION and both matching entries in Gemfile.lock.
  • Dates the existing changelog section.
  • No new actionable issues found.

Reviews (3) · Last reviewed commit: "chore: prepare version 0.17.2" · Reviewed by Greptile

Track C finished: 13 of 16 implementation attempts passed. Its report
proposed three more changes, applied here:

- Codex opened the agent guide in 1 of 8 attempts. The README now
  names the agent guide at the start of Installation.
- One attempt computed expiry from the clock in a query, so a hold
  read as released before the reminder ran. The agent guide now says
  that a reminder changes state only when it runs and that a query
  must read the committed state.
- The current-release note now also appears where Track C pointed.
@cardmagic

Copy link
Copy Markdown
Owner Author

@greptileai Please review the latest commit 42ac757. It adds the Track C findings: the README names the agent guide at the start of Installation, the agent guide says a reminder changes state only when it runs under solid_objects start, and the quickstart repeats the current-release note. rake quickstart still passes.

@context7

context7 Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

Docs7 for cardmagic/solid-objects-ruby

Result Status Action
Deployment ➖ Not used —
Content review ✅ Passed. No problems found. View findings

Commit 2c49cb8

@cardmagic

Copy link
Copy Markdown
Owner Author

@greptileai Please review the latest commit 2c49cb8. It prepares 0.17.2: version.rb, Gemfile.lock, and the dated CHANGELOG section. No other change.

@cardmagic
cardmagic merged commit d535fdb into main Oct 8, 2026
44 checks passed
@cardmagic
cardmagic deleted the docs/agent-guide-fixes branch October 8, 2026 09:07
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.

1 participant