Skip to content

Some Readme content edits #291

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 19 commits into from
Dec 8, 2024
Merged

Some Readme content edits #291

merged 19 commits into from
Dec 8, 2024

Conversation

mjbear
Copy link

@mjbear mjbear commented Dec 6, 2024

Overall some minor items in the Readme content.

  • Fix typo(s)
  • Change quoted area to an Alert (a.k.a. admonition)
  • Replace a broken netdevops.me hyperlink with an archive.org copy of that page
  • Move the Connection Mode list into a table
  • Various wording and sentence changes (admittedly my take and can be adjusted)
  • Markdown linting-esque changes
    • (full MD linting and GH Actions for another PR!)
    • Surround MD headers with white space
    • Break long MD lines into shorter lines

I'm open to feedback and any tweaks/changes.

Minor change to convert the quoted text section to an Alert section
Add archive.org label near the netdevops.me post hyperlink
Copy link
Owner

@hellt hellt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @mjbear
a couple of small additions

mjbear and others added 2 commits December 7, 2024 08:04
Co-authored-by: Roman Dodin <dodin.roman@gmail.com>
Co-authored-by: Roman Dodin <dodin.roman@gmail.com>
@mjbear
Copy link
Author

mjbear commented Dec 7, 2024

thanks @mjbear a couple of small additions

Thank you @hellt
I'm going to give the documentation another read or two. I'll mark it as "Ready" when I have it ready for merging.
Thank you!

@mjbear
Copy link
Author

mjbear commented Dec 7, 2024

@hellt
Admittedly my take on some of the sentences and wording. Hopefully I didn't distort the intended information and message.

Just like your earlier suggestions, I'm open to them. 😀

@mjbear mjbear requested a review from hellt December 7, 2024 21:52
@mjbear mjbear marked this pull request as ready for review December 7, 2024 21:53
@hellt hellt merged commit b048c4c into hellt:master Dec 8, 2024
1 check passed
@hellt
Copy link
Owner

hellt commented Dec 8, 2024

thank you

@mjbear mjbear deleted the readme_edits branch December 8, 2024 23:53
@mjbear
Copy link
Author

mjbear commented Dec 8, 2024

thank you

Teamwork!
Thank you as well. 😀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants