Fix/improve install from source docs #231
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File was messed up: fix and improve.
Fix broken link to /doc/installation/source.md
joeyates
requested changes
Mar 12, 2025
docs/installation/source.md
Outdated
|
|
||
| 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.
| @@ -143,7 +143,9 @@ If that doesn't work, see the [detailed installation instructions](/docs/install | |||
|
|
|||
| <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 ! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Quick doc + README fixes.