Livepeer.Cloud SPE Milestone #1 Deliverables: Add Gateway Docs #554
Conversation
gateways/guides/gateway-overview.mdx
Outdated
| of the Livepeer protocol. You dont have to be an expert, but troubleshooting | ||
| skills will come in handy. For more information view the go Livepeer [installation guide.](//orchestrators/guides/install-go-livepeer) | ||
|
|
||
|
|
There was a problem hiding this comment.
I think the formatting can be improved like here for example there is a redundant space. The easiest way to fix those styling errors is by running prettiers's mdx plugin.
There was a problem hiding this comment.
Is this plugin already part of the repo? if so, should this run against all the mdx files?
There was a problem hiding this comment.
BTW, I fixed the spacing in this file manually.
There was a problem hiding this comment.
It is not part of the repo. I have it in Vscode. I am not sure if the team already uses prettier for the docs. Let's see what @adamsoffer has to say about this 👍🏻.
There was a problem hiding this comment.
Yeah I'm cool with running prettier's mdx plugin against all the mdx files 👍
There was a problem hiding this comment.
@mikezupper I created a pull request with the prettier suggestions. Feel free to merge if you think it improves the readability -> https://github.com/mikezupper/livepeer-docs/pull/3/files.
| apt remove docker* | ||
| ``` | ||
|
|
||
| Install Docker |
There was a problem hiding this comment.
I think replacing this text by steps might improve readability.
There was a problem hiding this comment.
I would agree that steps make it look better, but we followed the Orchestrator Installation Guide formatting. Is this something you feel is critical to change?
There was a problem hiding this comment.
Ah I see 👍🏻. Let's leave that decision to @adamsoffer.
There was a problem hiding this comment.
The Steps component is nice. Feel free to make the change to both guides. Totally fine if you prefer to change them in a follow up PR.
No description provided.