Skip to content

docs: fix wording, fix Rails floor - #46

Merged
cardmagic merged 2 commits into
mainfrom
docs/remove-ai-phrasing
Aug 22, 2026
Merged

docs: fix wording, fix Rails floor#46
cardmagic merged 2 commits into
mainfrom
docs/remove-ai-phrasing

Conversation

@cardmagic

@cardmagic cardmagic commented Aug 22, 2026

Copy link
Copy Markdown
Owner

Improve prose

An audit against the common markers of AI-generated prose found
five small instances: the two em dashes in the README opening,
the word "excellent" in two places, the vague "modern DML
support", and an abstract cross-reference sentence in the state
migration guide. Each is rewritten in Simplified Technical
English with the specific fact the vague word hid: SQLite 3.35
is the floor because of RETURNING.

The audit also found one stale claim: the Solid Queue research
notes still said the gem requires Rails 8.0 because of the
SQLite immediate-transaction default. The floor moved to Rails
7.1 in c67797d, and the suite passes on 7.1 and 7.2 with the
deferred default, so the entry now records the real constraint:
Rails 7.0 pins sqlite3 1.4, which lacks the busy-handler
control this gem depends on.
@greptile-apps

greptile-apps Bot commented Aug 22, 2026

Copy link
Copy Markdown

Greptile Summary

This documentation-only PR improves introductory prose and corrects the documented Rails and SQLite compatibility floors.

  • Refines the README’s description and comparison wording.
  • Documents Rails 7.1 as the minimum supported version and SQLite 3.35 as the adapter floor.
  • Clarifies the scope of the state-migration guide.

Confidence Score: 5/5

The PR appears safe to merge.

No blocking failure remains.

Important Files Changed

Filename Overview
README.md Refines product descriptions and comparison wording without changing documented behavior.
docs/research/solid_queue.md Corrects the Rails compatibility floor and removes the inaccurate SQLite feature rationale from the prior review thread.
docs/state-migrations.md Clarifies that the guide applies to state already owned by Solid Objects.

Reviews (2): Last reviewed commit: "docs: state the SQLite floor without a r..." | Re-trigger Greptile

Comment thread docs/research/solid_queue.md Outdated
- MySQL documentation inspected was MySQL 8.4. Solid Objects supports MySQL 8.0 and newer with InnoDB.
- SQLite documentation inspected covers current SQLite behavior. Solid Objects requires SQLite 3.35 or newer for modern DML support.
- Rails documentation and source inspected cover Rails 8.1. Solid Objects requires Rails 8.0 or newer because Rails 8 changed the SQLite adapter's default write transaction from deferred to immediate, which the SQLite coordination contract relies on.
- SQLite documentation inspected covers current SQLite behavior. Solid Objects requires SQLite 3.35 or newer for `RETURNING` support.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Incorrect SQLite floor rationale

This attributes the SQLite 3.35 floor to RETURNING, but Solid Objects does not use that feature and the adapter documentation associates SQLite support with serialized write transactions. The explanation therefore gives readers an inaccurate basis for compatibility and design decisions.

Suggested change
- SQLite documentation inspected covers current SQLite behavior. Solid Objects requires SQLite 3.35 or newer for `RETURNING` support.
- SQLite documentation inspected covers current SQLite behavior. Solid Objects supports SQLite 3.35 or newer.

Knowledge Base Used: Configuration and database adapters

Prompt To Fix With AI
This is a comment left during a code review.
Path: docs/research/solid_queue.md
Line: 529

Comment:
**Incorrect SQLite floor rationale**

This attributes the SQLite 3.35 floor to `RETURNING`, but Solid Objects does not use that feature and the adapter documentation associates SQLite support with serialized write transactions. The explanation therefore gives readers an inaccurate basis for compatibility and design decisions.

```suggestion
- SQLite documentation inspected covers current SQLite behavior. Solid Objects supports SQLite 3.35 or newer.
```

**Knowledge Base Used:** [Configuration and database adapters](https://app.greptile.com/craftsmanfounder/-/custom-context/knowledge-base/cardmagic/solid_objects/-/docs/configuration-and-database-adapters.md)

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

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

Correct. The code does not use RETURNING, and the floor comes from the startup version check (201fd33). Fixed in 539a0a0: the entry now states the supported version without a feature rationale.

@cardmagic cardmagic changed the title docs: remove AI-tell phrasing, fix Rails floor docs: fix wording, fix Rails floor Aug 22, 2026
Review found the previous edit attributed the 3.35 floor to
RETURNING, which the code never uses. The floor is the oldest
server version the adapter's startup check accepts (201fd33),
not a single-feature requirement, so the entry now states the
supported version without inventing a reason.
@cardmagic
cardmagic merged commit 760f7f9 into main Aug 22, 2026
41 checks passed
@cardmagic
cardmagic deleted the docs/remove-ai-phrasing branch August 22, 2026 22:31
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