📖[Docs]: Improve README clarity and formatting #192
Merged
Conversation
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
… teardown scripts
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR improves the README documentation by enhancing formatting, structure, and readability. The changes focus on better visual organization and consistency across workflow descriptions and test setup documentation.
- Improved workflow step descriptions with consistent nested bullet point formatting
- Reorganized BeforeAll/AfterAll documentation with clearer section structure and simplified content
- Enhanced code formatting consistency by changing file references from bold to inline code format
MariusStorhaug
changed the title
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…iple prompt and template files
MariusStorhaug
added
documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This release comprehensively improves documentation quality across the entire repository by fixing 21 instances of typos, grammatical errors, and formatting inconsistencies in 9 files. All changes enhance readability, professionalism, and clarity without any breaking changes or functionality modifications.
Why These Changes Matter
Documentation is the first point of contact for users and contributors. Unclear language, typos, and inconsistent formatting create friction and reduce confidence in the project. Poor documentation quality can lead to misunderstandings, incorrect implementations, and increased support burden. These improvements make the documentation more professional, scannable, and easier to understand for both new users and experienced contributors.
How the Documentation Was Improved
The improvements span three main categories:
Grammar & Language Clarity: Fixed verb tense inconsistencies ("trigger" → "triggered"), corrected countable vs uncountable noun usage ("less" → "fewer"), added Oxford commas for better readability, improved sentence structure, and added missing articles throughout.
Formatting Standardization: Standardized file references using inline code formatting (
`BeforeAll.ps1`), converted mathematical notation to proper Unicode symbols (≤ instead of <=), improved list structures with consistent nested bullets, and enhanced visual hierarchy in workflow documentation.Content Restructuring: Reorganized test setup/teardown documentation for better flow, moved key information to prominent positions, eliminated redundant sections, integrated scattered information into main descriptions, and created clearer section divisions.