Repository navigation
Conversation
Use short active sentences, approved verb forms, and one term per concept. Remove banned modals and filler words. Split long lists and sentences.
gnodet-bot
left a comment
There was a problem hiding this comment.
This PR improves the site documentation to use plain, direct language — a good cleanup overall. Two inconsistencies worth addressing:
skipping-clean.md.vm: The H1 heading and frontmattertitlestill read "Skipping Clean" whilesite.xmlwas updated to "Skip Clean". The three names should match.index.md: The rewritten paragraph (lines 41–43) still contains informal constructs that were presumably targeted by this style pass: "feel free to", "could already contain", and "Hence, it is also worth browsing/searching".
This review was generated by an AI agent, Hermès on behalf of @gnodet.
Co-authored-by: Guillaume Nodet - AI Bot <gnodet+bot@gmail.com>
Co-authored-by: Guillaume Nodet - AI Bot <gnodet+bot@gmail.com>
gnodet-bot
left a comment
There was a problem hiding this comment.
Following up on my earlier review — 1 of the 2 issues has been addressed.
-
index.mdinformal constructs (feel free to,could already contain,Hence, it is also worth browsing/searching) — ✅ addressed. The paragraph is now clean. -
skipping-clean.md.vmtitle/H1 mismatch —⚠️ still open. The H1 was corrected to# Skip Clean, but the frontmattertitle:on line 2 still readstitle: Skipping Clean. The nav label insite.xmlwas updated toSkip Clean. All three names should match:title:in frontmatter →Skipping Clean❌# Skip Clean(H1) ✅site.xmlnav item:Skip Clean✅
Please update the frontmatter to
title: Skip Clean.
This review was generated by an AI agent, Hermès on behalf of @gnodet.
Rewrite the prose in
src/siteto follow ASD-STE100 Simplified Technical English.Changes:
should,could,may) and filler words (simply,comprehensive,it is worth noting).-ingclauses and passive voice with direct verbs.verifyfor integrity checks.Files changed:
src/site/markdown/index.mdsrc/site/markdown/usage.md.vmsrc/site/markdown/faq.mdsrc/site/markdown/examples/delete_additional_files.md.vmsrc/site/markdown/examples/ignoring-errors.md.vmsrc/site/markdown/examples/skipping-clean.md.vmsrc/site/xdoc/download.xml.vmsrc/site/site.xml(navigation labels match the new page titles)The FAQ anchors stay valid. The XML files parse without errors.