Skip to content
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

Modified README Markdown Formatting #8

Merged
merged 6 commits into from
Dec 10, 2024
Merged

Conversation

mjbear
Copy link
Contributor

@mjbear mjbear commented Dec 10, 2024

A bit of a spontaneous round of edits.
I'm open to discussion if anything seems off or is unwanted. Thank you!

  • Spelling: ontop >> on top
  • Spelling: virtualisation >> virtualization (since the latter appears most often in the MD)
  • Formatting: use bullets for reference links (so they don't mush into a single line)
  • Formatting: change case of PowerShell to be titlecase
  • Formatting: titlecase Markdown headers
  • Formatting: combine two adjacent MD code fences into one code fence (same syntax/language)

Note: I plan to give the MD another re-read or two to see if there are any other tweaks.

The American spelling of virtualization with a "z" was most prevalent. Changing virtualisation to match the usage throughout.
Fix the references hyperlinks that run together on one line.

It was either separate them with a blank line or turn them to bullet points. I chose bullet points.
(minor) Change the case of PowerShell to make the PS docs.
https://learn.microsoft.com/en-us/powershell/

(Only changed instances of the noun and not the syntax highlighting for code fences.)
Combine two adjacent code fences (each with a single command of the same programming language) into one code fence.

Left a blank line between the two commands to improve readability.
@mjbear mjbear changed the title Modified README Markdown formatting Modified README Markdown Formatting Dec 10, 2024
@kaelemc
Copy link
Collaborator

kaelemc commented Dec 10, 2024

@mjbear Thanks!

When you're ready @FloSch62 or I can merge.

@FloSch62 FloSch62 marked this pull request as ready for review December 10, 2024 21:13
@FloSch62 FloSch62 merged commit 7e54c56 into srl-labs:main Dec 10, 2024
@mjbear mjbear deleted the readme_edits branch December 10, 2024 21:51
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.

3 participants