aimem: mirror the ISO 24495-1 plain-language pass - #7
Conversation
Ports the aimem skill-template changes from miniohq/aimem#167, which applied the ISO 24495-1 Plain Language standard across that repository's documentation. The substantive change is in SKILL.md. It previously advertised references/navigation.md as covering "how to identify the bucket/region/endpoint of your mount", but navigation.md states the opposite — those commands locate the mount only, and nothing on the mount exposes the bucket, region, or endpoint. An agent following that pointer to answer "which bucket am I on?" reached a page telling it the question could not be answered there. The bullet now describes what navigation.md actually covers. The six reference pages get sentence-level clarity fixes only, with no change in meaning: long multi-clause sentences split, an em-dash aside moved out from between a subject and its verb, and a passive construction given its actor. Intentional divergences from the upstream templates are preserved: - SKILL.md keeps this repository's extra front matter (license, compatibility, metadata) and omits the {aimem_version} / {generated} placeholders, which are substituted by the aimem binary at install time and have no meaning here. - SKILL.md and references/navigation.md keep this repository's better mount lookup (`findmnt -n -o TARGET -S aimem` and the awk fallback) rather than the upstream `findmnt -S aimem` form. AGENTS.preamble.md is deliberately not mirrored: it is the aimem read-time overlay, injected into instruction files by the binary, not part of the installable skill. Signed-off-by: Harshavardhana <harsha@minio.io>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (7)
📝 WalkthroughWalkthroughThe documentation clarifies AIStor Memory mount navigation, agent context paths, metadata behavior, annotation guidance, search output formats, and concurrent-writer behavior. ChangesAIStor Memory documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Ports the
aimemskill-template changes from miniohq/aimem#167, which applied the ISO 24495-1 Plain Language standard across that repository's documentation. Mirroring skill changes here is a standing requirement.The substantive change
SKILL.mdadvertisedreferences/navigation.mdas covering "how to identify the bucket/region/endpoint of your mount".navigation.mdstates the opposite — those commands locate the mount only, and nothing on the mount exposes the bucket, region, or endpoint. An agent following that pointer to answer "which bucket am I on?" landed on a page telling it the question couldn't be answered there.That's a behavioural defect in the installed skill, not a wording preference, and it's the main reason this mirror matters:
The rest
The six reference pages get sentence-level clarity fixes with no change in meaning — long multi-clause sentences split, an em-dash aside moved out from between a subject and its verb, a passive construction given its actor. Total diff is 17 insertions / 17 deletions across 7 files.
Divergences deliberately preserved
This repo's copies are not verbatim upstream, and the port keeps every existing difference:
SKILL.mdkeeps this repo's extra front matter (license,compatibility,metadata) and omits the{aimem_version}/{generated}placeholders, which the aimem binary substitutes at install time and which have no meaning here.SKILL.mdandreferences/navigation.mdkeep this repo's better mount lookup —findmnt -n -o TARGET -S aimemplus theawkfallback — rather than upstream'sfindmnt -S aimemform. Upstream is arguably the one that should adopt this.Verified after porting: the only remaining differences against the post-#167 templates are those three, and no
{...}placeholder leaked into any file.AGENTS.preamble.mdis not mirrored: it's the aimem read-time overlay injected into instruction files by the binary, not part of the installable skill.Summary by CodeRabbit