Apply IOG style guide updates to documentation#1
Open
oduameh wants to merge 13 commits into
Open
Conversation
- Convert passive voice to active voice throughout - Fix punctuation: double quotes to single quotes for consistency - Update heading capitalization to sentence case - Improve bullet list formatting and punctuation - Fix spelling errors and typos - Enhance clarity and readability per IOG guidelines All changes maintain technical accuracy while improving consistency and professionalism across the documentation set.
oduameh
marked this pull request as draft
November 5, 2025 13:33
olgahryniuk
suggested changes
Nov 5, 2025
Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com>
- Fix all headings to sentence case per style guide
- Fix capitalization after colons in bullet lists (lowercase)
- Remove overly conversational tone throughout
- Change to imperative 'do it' tone instead of 'we will' or 'let's'
- Add colons before all code snippets consistently
- Fix typos: startup -> start-up, db -> DB, instrudts -> instructs
- Improve capitalization: SSH, PuTTY, ADA, UTXO, NTP
- Fix Mithril capitalization throughout
- Remove casual phrases ('grab files', 'before we get rolling', etc)
- Preserve all of Olga's accepted suggestions from previous PR
- Ensure full compliance with IOG technical writing guidelines
oduameh
marked this pull request as ready for review
November 12, 2025 14:59
Minor tweaks: capitalization, word choice.
Minor edits
Minor edits and rewording.
Minor improvements
Several style improvements.
Capitalization edits and more.
Copy style and flow improvements.
Style improvements
olgahryniuk
approved these changes
Nov 13, 2025
olgahryniuk
left a comment
olgahryniuk
left a comment
There was a problem hiding this comment.
@oduameh, I have now completed my final review. I updated all files directly to address some remaining inconsistencies. This is good to go for Jesse's review. Thanks.
Author
|
Hi @Profsmith9000, The docs team has now completed the review of this course |
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
2 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
This PR applies comprehensive style guide updates to all documentation files based on the IOG Technical Writing Guidelines.
Changes Made
Impact
All changes maintain technical accuracy while improving consistency and professionalism across the documentation set. No functionality or technical content has been altered.