Skip to content

Rewrite site documentation in ASD-STE100 Simplified Technical English - #368

Open
elharo wants to merge 7 commits into
maven-clean-plugin-4.xfrom
site-simplified-english
Open

elharo wants to merge 7 commits into
maven-clean-plugin-4.xfrom
site-simplified-english

Conversation

@elharo

@elharo elharo commented Oct 12, 2026

Copy link
Copy Markdown
Contributor

Rewrite the prose in src/site to follow ASD-STE100 Simplified Technical English.

Changes:

  • Use short active sentences. Split long sentences and conditions.
  • Remove banned modals (should, could, may) and filler words (simply, comprehensive, it is worth noting).
  • Use approved verb forms. Replace -ing clauses and passive voice with direct verbs.
  • Use one term per concept, for example verify for integrity checks.
  • Turn lists of three or more items into vertical lists.
  • Keep code blocks, identifiers, CLI commands, file paths, and quoted error messages unchanged.

Files changed:

  • src/site/markdown/index.md
  • src/site/markdown/usage.md.vm
  • src/site/markdown/faq.md
  • src/site/markdown/examples/delete_additional_files.md.vm
  • src/site/markdown/examples/ignoring-errors.md.vm
  • src/site/markdown/examples/skipping-clean.md.vm
  • src/site/xdoc/download.xml.vm
  • src/site/site.xml (navigation labels match the new page titles)

The FAQ anchors stay valid. The XML files parse without errors.

Use short active sentences, approved verb forms, and one term per concept.
Remove banned modals and filler words. Split long lists and sentences.
@elharo
elharo marked this pull request as draft October 12, 2026 12:05
@elharo
elharo marked this pull request as ready for review October 12, 2026 12:24
@elharo
elharo requested a review from slachiewicz October 12, 2026 12:24

@gnodet-bot gnodet-bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This PR improves the site documentation to use plain, direct language — a good cleanup overall. Two inconsistencies worth addressing:

  1. skipping-clean.md.vm: The H1 heading and frontmatter title still read "Skipping Clean" while site.xml was updated to "Skip Clean". The three names should match.
  2. 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.

Comment thread src/site/markdown/examples/skipping-clean.md.vm Outdated
Comment thread src/site/markdown/index.md Outdated
elharo and others added 2 commits October 20, 2026 11:06
Co-authored-by: Guillaume Nodet - AI Bot <gnodet+bot@gmail.com>
Co-authored-by: Guillaume Nodet - AI Bot <gnodet+bot@gmail.com>

@gnodet-bot gnodet-bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Following up on my earlier review — 1 of the 2 issues has been addressed.

  • index.md informal constructs (feel free to, could already contain, Hence, it is also worth browsing/searching) — ✅ addressed. The paragraph is now clean.

  • skipping-clean.md.vm title/H1 mismatch — ⚠️ still open. The H1 was corrected to # Skip Clean, but the frontmatter title: on line 2 still reads title: Skipping Clean. The nav label in site.xml was updated to Skip Clean. All three names should match:

    • title: in frontmatter → Skipping Clean ❌
    • # Skip Clean (H1) ✅
    • site.xml nav 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.

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