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

Fix markdown typos in Contributing docs page #846

Merged
merged 3 commits into from
Jul 22, 2019

Conversation

vdepizzol
Copy link
Contributor

@vdepizzol vdepizzol commented Jul 22, 2019

I found a few markdown typos in the Getting Started/Contributing docs page, that were ultimately generating glitches in the output text.

  • A bullet list was missing a space after the dash
  • rendering triple backticks inside an inline code block was breaking a paragraph
  • The Versioning section fell inside a code block

PS: I haven't checked how the markdown file renders in the final template — I just validated the markdown syntax with GitHub's preview mode (which was catching the same problems found on the Primer website)

While this fixes the backtick-on-backtick problem by using a zero-width space, it's still confusing to see `erb` in the source code while referencing `html` in the copy.
@vercel
Copy link

vercel bot commented Jul 22, 2019

This pull request is automatically deployed with Now.
To access deployments, click Details below or on the icon next to each push.

@ashygee ashygee requested a review from shawnbot July 22, 2019 21:23
@shawnbot shawnbot changed the base branch from master to release-12.5.0 July 22, 2019 23:15
Copy link
Contributor

@shawnbot shawnbot left a comment

Choose a reason for hiding this comment

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

Awesome, thanks!

@shawnbot shawnbot merged commit 01af8f3 into primer:release-12.5.0 Jul 22, 2019
@simurai simurai mentioned this pull request Jul 23, 2019
16 tasks
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