Fix/improve install from source docs#231
Conversation
File was messed up: fix and improve.
Fix broken link to /doc/installation/source.md
joeyates
left a comment
joeyates
left a comment
There was a problem hiding this comment.
Thanks for the PR. I've added a couple of notes for quick fixes
docs/installation/source.md
Outdated
| congratulations, you have succesfully built imap-backup. | ||
|
|
||
| Check that it runs | ||
| You ca now run the following to see the built-in help: |
There was a problem hiding this comment.
Thanks, now fixed.
| ``` | ||
| imap-backup 14.4.4 | ||
| ``` | ||
| congratulations, you have succesfully built imap-backup. |
There was a problem hiding this comment.
There should be a blank line after code blocks.
|
|
||
| <details> | ||
| <summary>From Source Code</summary> | ||
|
|
There was a problem hiding this comment.
From what I can see, this doesn't change the rendered document. Is the newline needed?
There was a problem hiding this comment.
When playing with the Github preview it seemed necessary to get [here](/docs/installation/source.md) to render as a link. Currently, that render is not working. And, looking at it some more, it's also needed for the * [Rubygem] and Homebrew shield to render properly, both are also currently not rendering right. I'll fix those too.
Make Ruby gem link and Homebrew shield render correctly.
|
Thanks @axelsimon ! |
2 participants
Quick doc + README fixes.