Fixed broken links and /newline issues #13
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
I opted to fix the links by adding `../` instead of removing `md/`. This is because I figured for maintainability, it's much easier to do a find/replace on `"../md` than it is on `"`. I also got rid of a few extraneous bullets and fixed some newline issues which arose because the trailing `>` on the Markdown HTML needs a blank newline or else it causes the subsequent character to get garbled.
|
Hmm, on second thought, this file might not be intended to be rendered from within the source code tree. I hadn't seen it in the server's walkthrough, but now I do and I wonder if this PR is misplaced. If so, it might make sense to have a top-level file in https://github.com/norandomtechie/ece270-simulator/tree/master/md which explains how to view the contents directory. Maybe it's just enough to say something like "these |
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.
I opted to fix the links by adding
../instead of removingmd/. This is because I figured for maintainability, it's much easier to do a find/replace on"../mdthan it is on".I also got rid of a few extraneous bullets and fixed some newline issues which arose because the trailing
>on the Markdown HTML needs a blank newline or else it causes the subsequent character to get garbled.