Rewrite site documentation in Simplified Technical English - #173
Open
elharo wants to merge 6 commits into
Open
Conversation
Update the index and download pages to comply with ASD-STE100. Use short sentences, approved modals (can, will, must), and the imperative for instructions. Remove filler words, semicolons, present perfect, and -ing verb forms. Code samples, identifiers, and links are unchanged.
Member
|
@perNyfelt ping |
perNyfelt
reviewed
Aug 6, 2026
perNyfelt
left a comment
perNyfelt
left a comment
Contributor
There was a problem hiding this comment.
src/site/markdown/index.md:44: The default user settings path is incomplete. The implementation (AetherUtils.findUserSettings()) checks ${user.home}/.ant/settings.xml first, then falls back to
${user.home}/.m2/settings.xml. This precedence should probably be documented.
elharo
commented
Aug 7, 2026
elharo
left a comment
elharo
left a comment
Contributor
Author
There was a problem hiding this comment.
The concern about settings precedence is valid. However, that feels like it needs a separate and deliberate PR that shouldn't be hidden inside a style rewrite. I'm going to file an issue for that.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Rewrites the prose in
src/sitedocumentation according to ASD-STE100 Simplified Technical English.Changes
should/would/may/might/could.Untouched
Code blocks, identifiers, CLI commands, file paths, links, product names, and license headers are unchanged.
Files: 2 (
src/site/markdown/index.md,src/site/xdoc/download.xml.vm).Documentation only; no functional changes.