Improve Language of Documentation #126
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
Signed-off-by: Niklas Eiling <[email protected]>
Signed-off-by: Niklas Eiling <[email protected]>
Signed-off-by: Niklas Eiling <[email protected]>
Signed-off-by: Niklas Eiling <[email protected]>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR refines documentation language across the project, correcting typos, improving grammar, and clarifying wording.
- Fixed spelling and grammatical errors in multiple docs
- Standardized formatting and terminology (e.g., WebSockets, FPGA, environment variables)
- Updated copyright notices for consistency
Reviewed Changes
Copilot reviewed 23 out of 23 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docusaurus.config.js | Corrected spelling and updated copyright text |
| docs/web/index.md | Improved phrasing and punctuation in introductory text |
| docs/web/development/frontend.md | Fixed build-to-built typo |
| docs/web/branding.md | Standardized brand name and clarified instructions |
| docs/users.md | Corrected institution name spellings |
| docs/publications.md | Fixed DOI URL formatting and publication ordering |
| docs/node/usage/villas-test.md | Corrected 'plausibility' spelling |
| docs/node/usage/villas-relay.md | Fixed 'separate' spelling |
| docs/node/netem.md | Improved grammar, punctuation, and unit symbols |
| docs/node/index.md | Refined feature list bullets and grammar consistency |
| docs/node/guides/lab8.md | Removed duplicated word |
| docs/node/guides/lab13.md | Fixed extra period in figcaption |
| docs/node/formats/villas_human.md | Corrected 'separated' spelling |
| docs/node/development/contributing.md | Fixed 'contain' typo |
| docs/node/clients/rtds_ml507_gtfpga.md | Replaced "it's" with "its" |
| docs/node/clients/rtds_gtnet_skt.md | Clarified timestamp override phrasing |
| docs/installation.md | Fixed 'deploy' spelling and comment phrasing |
| docs/index.md | Updated copyright date and authorship |
| docs/fpga/setup.md | Improved grammar and punctuation |
| docs/fpga/index.md | Corrected run-on sentences and interface descriptions |
| docs/fpga/configuration.md | Clarified configuration wording |
| docs/controller/usage.md | Fixed verb agreement and formatting |
| docs/controller/protocol.md | Clarified terminology and JSON formatting |
Comments suppressed due to low confidence (2)
docs/web/branding.md:48
- [nitpick] The icon description contains unnecessary parentheses and an exclamation mark. Consider simplifying it to something like
icon: "<brand icon path in the public folder>"for clarity.
icon: "<brand icon, (must be in the public folder with the favicon)!",
docs/node/index.md:55
- [nitpick] This bullet is a sentence fragment starting with 'Or'. Consider merging it with the previous bullet or rephrasing to form a complete sentence, e.g., 'Similarly, the file node type logs or replays simulation data...' for clarity.
Or the [file node type](nodes/file.md), which logs or replays simulation data from the hard disk.
Co-authored-by: Copilot <[email protected]> Signed-off-by: Niklas Eiling <[email protected]>
Contributor
|
Looks great :) Thanks! |
stv0g
approved these changes
Jul 4, 2025
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.
Some AI assisted language improvements.