Skip to content

README - fix up markdown#158

Merged
sam-s-maher merged 3 commits intomainfrom
clean-up-readme
Jun 6, 2025
Merged

README - fix up markdown#158
sam-s-maher merged 3 commits intomainfrom
clean-up-readme

Conversation

@wicksipedia
Copy link
Member

When I looked at the readme, I noticed that some of the code blocks were not rendering properly since they had different levels on indentation with the ordered list items they were under.

This pull request makes minor formatting improvements to the README.md file to enhance readability and consistency. The changes include the addition of blank lines for better spacing and the removal of unnecessary blank lines in code blocks and instructions.

Formatting improvements:

  • Added blank lines between sections in the Table of Contents for better readability. (README.md: README.mdL16-R24)
  • Inserted blank lines before and after lists in the "Getting Started" and "Adding a Feature Slice" sections to improve spacing and clarity. (README.md: [1] [2]
  • Removed unnecessary blank lines within code blocks and instructions to maintain a cleaner structure. (README.md: README.mdR129-L175)

Copy link
Member

@sam-s-maher sam-s-maher left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@sam-s-maher sam-s-maher merged commit d8e75f6 into main Jun 6, 2025
3 checks passed
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