Skip to content

docs: rewrite creating-a-repository-system-session.md to STE rules - #2034

Merged
cstamas merged 8 commits into
masterfrom
ste100-doc-rewrite
Aug 5, 2026
Merged

cstamas merged 8 commits into
masterfrom
ste100-doc-rewrite

Conversation

@elharo

@elharo elharo commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Rewrite the page to ASD-STE100 Simplified Technical English, following the pattern of prior doc rewrites (#2022, #2024, #2026).

Key changes:

  • Separated descriptive and procedural passages; procedural text uses the imperative mood.
  • Removed banned modals ("should") and non-approved verb forms ("-ing", "has to be").
  • Split long sentences; kept each descriptive sentence at or under 25 words and each procedural sentence at or under 20 words.
  • Removed filler words and simplified expressions.
  • Preserved the code example and all links verbatim.

@elharo
elharo marked this pull request as draft August 5, 2026 13:24
@elharo
elharo requested a review from cstamas August 5, 2026 13:31
@elharo
elharo marked this pull request as ready for review August 5, 2026 13:31

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

Good STE rewrite — sentence splitting and active voice improve readability, and the "former" → "formerly" fix is a nice catch. One item to address 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/creating-a-repository-system-session.md
@cstamas
cstamas merged commit 56caa76 into master Aug 5, 2026
23 checks passed
@cstamas
cstamas deleted the ste100-doc-rewrite branch August 5, 2026 21:29
@github-actions

github-actions Bot commented Aug 5, 2026

Copy link
Copy Markdown

@cstamas Please assign appropriate label to PR according to the type of change.

@github-actions github-actions Bot added this to the 2.0.22 milestone Aug 5, 2026
@cstamas cstamas added the documentation Improvements or additions to documentation label Aug 5, 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.

3 participants