search

ethereum-optimism / stack-docs

OP Stack documentation
13 stars 32 forks source link

Added missing \ in the OP Stack Getting Started #16

Closed Turupawn closed 1 year ago

Turupawn commented 1 year ago

Description

Added a missing \ character that prevents correct rendering on markdown.

Tests

No tests added since this is does not make any changes in behaviour or logic. This is a documentation only change.

Additional context

You can see how the current markdown fails to render on this page: https://github.com/ethereum-optimism/stack-docs/blob/main/src/docs/build/getting-started.md See the "`curl -fsSL https://deb.nodesource.com/setup_16.x" not being rendered correctly and this can lead to confusion.

Metadata

No issue created since this is a small fix. Lmk if you need me to create one.

Thanks to putting this togheter. I'll be doing guides about the OP stack on youtube and blog posts. This is very well explained. If I find more issues I'll report back.

netlify[bot] commented 1 year ago

Deploy request for opstack-docs pending review.

Visit the deploys page to approve it

Name Link
Latest commit e4d42435af7bb89e2934f9f715a0cf75c0bc3141
sbvegan commented 1 year ago

Ah I see the confusion now, the | is a pipe and not apart of the markdown syntax https://stackoverflow.com/questions/9834086/what-is-a-simple-explanation-for-how-pipes-work-in-bash

sbvegan commented 1 year ago

Thank you for your contributions! I see there's another PR you authored in the queue. I unfortunately don't have the time to review it right now, but we'll work on getting it reviewed soon

Turupawn commented 1 year ago

Thanks for reviewing! I'll keep an eye on this because I'll be creating more content about this. I see some changes that are still not reflected by the guides but I'll keep it one PR at the time