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

docs: changes in markdown for readability #106

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

msdolbey
Copy link

Signed-off-by: msdolbey [email protected]

This is a minor nit, but saw this and changed it on the README -
On main:
Screen Shot 2022-10-30 at 7 08 38 AM

With changes:
Screen Shot 2022-10-30 at 7 07 52 AM

markdown didn't like this when it was indented in without a list

@@ -0,0 +1,3 @@
## All changes

- made some markdown changes in the README (#xx, @msdolbey)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- made some markdown changes in the README (#xx, @msdolbey)
- made some markdown changes in the README (#106, @msdolbey)

Copy link
Collaborator

Choose a reason for hiding this comment

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

Thanks.
Plugins don't use these changelog files to generate the release note, so I think it's OK to not change. I will manually create the release note for GA.

@codecov-commenter
Copy link

Codecov Report

Merging #106 (29cee0d) into main (4a46a41) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #106   +/-   ##
=======================================
  Coverage   21.36%   21.36%           
=======================================
  Files           3        3           
  Lines         482      482           
=======================================
  Hits          103      103           
  Misses        375      375           
  Partials        4        4           

Copy link
Contributor

@jglick jglick left a comment

Choose a reason for hiding this comment

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

There are more code block problems that are not fixed here. See #97.

@blackpiglet
Copy link
Collaborator

There are more code block problems that are not fixed here. See #97.

I put some comments in #97
My opinion is just fixing the blocks impacting the MarkDown display is enough, but open to other options.

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.

5 participants