Skip to content

Docs: rewrite what-is-resolver page in Simplified Technical English (ASD-STE100) - #2022

Merged
elharo merged 8 commits into
masterfrom
docs/asd-ste100-what-is-resolver
Aug 3, 2026
Merged

Docs: rewrite what-is-resolver page in Simplified Technical English (ASD-STE100)#2022
elharo merged 8 commits into
masterfrom
docs/asd-ste100-what-is-resolver

Conversation

@elharo

@elharo elharo commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Summary

Rewrites src/site/markdown/what-is-resolver.md so that it follows the ASD-STE100 Simplified Technical English rules.

Changes

  • Classify the page as descriptive text. Use simple tenses only.
  • Remove all banned modals (would, may, might, could, should).
  • Remove contractions and present-perfect forms.
  • Remove gerund and participle verb forms, including in the heading ("Embedding Resolver" became "How To Embed Resolver").
  • Keep every sentence at or below 25 words and every paragraph at or below six sentences.
  • Remove non-factual filler words such as "well", "probably", and "your best bet".
  • Keep code identifiers, product names, and the license header unchanged.

Verification

Grepped the page for contractions, "has been", banned modals, ", making", and semicolons. All checks pass. The only remaining "-ing" word is the adjective "interesting".

@gnodet gnodet left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Nice documentation cleanup! The STE rewrite is a clear improvement in readability — the original "Embedding Resolver" section in particular was hard to follow with nested parentheticals. The fix from "former Aether" to "formerly Aether" also corrects a grammatical error in the original.

Two suggestions below for your consideration.

This review was generated by an AI agent (Claude Code) and may contain inaccuracies. Please verify all suggestions before applying.

On behalf of gnodet

Comment thread src/site/markdown/what-is-resolver.md Outdated
Comment thread src/site/markdown/what-is-resolver.md Outdated

@gnodet gnodet left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for addressing the semantic drift — "to share with others" now correctly preserves the original meaning. Two remaining items below.

This review was generated by an AI agent (Claude Code) and may contain inaccuracies. Please verify all suggestions before applying.

On behalf of gnodet

Comment thread src/site/markdown/what-is-resolver.md
Comment thread src/site/markdown/what-is-resolver.md
elharo and others added 3 commits August 3, 2026 15:37
@elharo elharo added the documentation Improvements or additions to documentation label Aug 3, 2026

@gnodet gnodet left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for restoring the hyperlinks (and upgrading them to HTTPS — nice touch!). Looks like the latest commit accidentally left a duplicate opening paragraph — the old version with the "to can use" typo is still present above the corrected version. Just need to delete the first copy.

This review was generated by an AI agent (Claude Code) and may contain inaccuracies. Please verify all suggestions before applying.

On behalf of gnodet

Comment thread src/site/markdown/what-is-resolver.md

@gnodet gnodet left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

All previous feedback addressed — duplicate paragraph removed, hyperlinks restored with HTTPS upgrades, and semantic drift fixed. LGTM!

One optional nit: the Central Repository URL has a stray query parameter (https://search.maven.org/?eh=) — could be cleaned to just https://search.maven.org/.

This review was generated by an AI agent (Claude Code) and may contain inaccuracies. Please verify all suggestions before applying.

On behalf of gnodet

@elharo
elharo merged commit 37afde0 into master Aug 3, 2026
23 checks passed
@elharo
elharo deleted the docs/asd-ste100-what-is-resolver branch August 3, 2026 19:54
@github-actions github-actions Bot added this to the 2.0.22 milestone Aug 3, 2026
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.

2 participants