Skip to content

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

Open
elharo wants to merge 19 commits into
masterfrom
ste100-docs-rewrite
Open

elharo wants to merge 19 commits into
masterfrom
ste100-docs-rewrite

Conversation

@elharo

@elharo elharo commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

Summary

Rewrites all 12 pages in src/site/markdown to ASD-STE100 Simplified Technical English:

  • index.md, usage.md.vm, faq.md
  • module-info-patch.md, modules.md, multirelease.md, sources.md
  • examples/ (9 files): annotation-processor, compile-using-different-jdk, compile-with-memory-enhancements, jpms_args, module-info, non-javac-compilers, pass-compiler-arguments, set-compiler-release, set-compiler-source-and-target

What changed

  • Split long sentences into shorter, single-topic ones (max 20-25 words).
  • Removed banned modals and words: should, would, may, might, could, don't, seamlessly, comprehensive.
  • Converted "-ing" verb forms to simple tenses.
  • Replaced e.g./i.e. with "for example"/"that is".
  • Made procedural steps imperative; kept descriptive passages in simple tenses.
  • Fixed typos (for example, "The preferred was to specify" -> "The preferred way").

Front matter, license headers, code blocks, and identifiers remain untouched. Net +253/-263 lines.

@elharo elharo added the documentation Improvements or additions to documentation label Aug 29, 2026
@elharo
elharo requested a review from bmarwell August 29, 2026 12:32

@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.

Good effort applying ASD-STE100 consistently across all 16 pages. The mechanical transformations (sentence splitting, modal removal, imperative procedural steps) are largely correct. However, there are a few issues that need fixing before this can merge.

This review was generated by an AI agent, Hermès on behalf of @gnodet.

Comment thread src/site/markdown/examples/annotation-processor.md Outdated
Comment thread src/site/markdown/examples/compile-using-different-jdk.md Outdated
Comment thread src/site/markdown/modules.md Outdated
Comment thread src/site/markdown/examples/set-compiler-source-and-target.md Outdated
@gnodet
gnodet dismissed gnodet-bot’s stale review September 23, 2026 19:25

All 4 findings addressed in 39c5e1d — JDK version boundary corrected (JDK 23 not 24), tense unified, trailing whitespace removed, must→should reverted, code fence blank line restored.

@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.

Re-review after the updated push. The four findings from the previous review are all addressed — good work fixing the JDK version boundary, the trailing whitespace, the should be semantics, and the blank line before the code fence in set-compiler-source-and-target.md. Three new issues introduced by this revision need fixing before merge.

This review was generated by an AI agent, Hermès on behalf of @gnodet.

Comment thread src/site/markdown/examples/compile-using-different-jdk.md Outdated
Comment thread src/site/markdown/modules.md Outdated
Comment thread src/site/markdown/modules.md
@gnodet
gnodet dismissed gnodet-bot’s stale review September 23, 2026 20:32

All 3 findings addressed in d83007d — missing 'to' in compile-using-different-jdk.md, become→becomes in modules.md, blank line before code fence in modules.md.

@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.

Re-review after the third push. Four of the seven previous findings are fully resolved: the "possible to assign" grammar error, the subject-verb agreement ("becomes confused"), the blank line before the code fence in modules.md, and the blank line before the code fence in set-compiler-source-and-target.md.

However, this push introduces three new regressions:

  1. Double space in annotation-processor.md line 102: ``only scans has two spaces between the closing backtick and "scans".
  2. Blank line removed before the opening code fence in pass-compiler-arguments.md (line 24→25 in new file).
  3. Blank line removed before the opening code fence in set-compiler-release.md (Maven 4 section, line 74→75 in new file).

Items 2 and 3 are the same class of Doxia/Markdown rendering regression flagged in the previous review — a fenced code block immediately following a paragraph without a blank line separator is treated as inline content, not a code block.

This review was generated by an AI agent, Hermès on behalf of @gnodet.

Comment thread src/site/markdown/examples/annotation-processor.md Outdated
Comment thread src/site/markdown/examples/pass-compiler-arguments.md
Comment thread src/site/markdown/examples/set-compiler-release.md
@gnodet
gnodet dismissed gnodet-bot’s stale review September 23, 2026 20:47

All 3 findings addressed in 1be9333 — double space removed, blank lines restored before code fences in pass-compiler-arguments.md and set-compiler-release.md.

@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.

Re-review after the fourth push. All three findings from the previous review are addressed — the double space in annotation-processor.md, and the missing blank lines before code fences in pass-compiler-arguments.md and set-compiler-release.md. Three new issues remain before this can merge.

This review was generated by an AI agent, Hermès on behalf of @gnodet.

Comment thread src/site/markdown/examples/compile-using-different-jdk.md Outdated
Comment thread src/site/markdown/examples/compile-using-different-jdk.md Outdated
Comment thread src/site/markdown/examples/compile-using-different-jdk.md Outdated
Comment thread src/site/markdown/examples/jpms_args.md Outdated
@gnodet
gnodet dismissed gnodet-bot’s stale review September 23, 2026 20:58

All 4 findings addressed in c724d54 — missing comma after 'By default', two 'might'→'can' (STE100 modal violations), 'can be incomplete'→'is probably incomplete' (semantic distortion restored).

@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.

Re-review after the fifth push. All three findings from the previous review are resolved — the missing comma after "By default", the two retained might modals in compile-using-different-jdk.md, and the can be incomplete semantic distortion in jpms_args.md. One minor inconsistency remains.

This review was generated by an AI agent, Hermès on behalf of @gnodet.


The developers must reproduce the problem to fix the bug. Patches are welcome.

Contributors can check out the project from the [source repository](./scm.html). They will find more information in the [guide to helping with Maven](https://maven.apache.org/guides/development/guide-helping.html).

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🔴 Banned modal will retained — inconsistent with the PR's own STE100 application.

The PR removed 19 other instances of will throughout this rewrite, but this sentence keeps will find. STE100 prefers present tense for habitual facts. Use find or restructure to imperative.

Suggested change
Contributors can check out the project from the [source repository](./scm.html). They will find more information in the [guide to helping with Maven](https://maven.apache.org/guides/development/guide-helping.html).
Contributors can check out the project from the [source repository](./scm.html). They find more information in the [guide to helping with Maven](https://maven.apache.org/guides/development/guide-helping.html).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants