Review wording of new documentation #34
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
marnovandermaas
force-pushed
the
ches_review
branch
4 times, most recently
from
a579c6a
to
593a2db
Compare
HU90m
requested changes
Sep 3, 2024
| Currently, there is one exercise: [Hardware Access Control](./hardware_access_control/README.md) | ||
| Currently, there is one exercise: [Hardware Access Control](./hardware_access_control/) |
There was a problem hiding this comment.
We want to point at the exercises readme and not it's directory. I think there's an important semantic difference.
There was a problem hiding this comment.
The reason I made this change is that link currently exits the mdbook and goes to GitHub. I would like it to stay within the mdbook. Happy to fix it in another way though.
There was a problem hiding this comment.
I think the reason you actually made this change was that this used to lead to .../README.html that didn't exist until the mdbook-regex PR. That PR the mistakenly redirected it to github. This will be fixed by #36
There was a problem hiding this comment.
Thanks for the fix!
marnovandermaas
force-pushed
the
ches_review
branch
4 times, most recently
from
2f6bc44
to
d399749
Compare
marnovandermaas
force-pushed
the
ches_review
branch
from
d399749
to
30eff74
Compare
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've done a first read through of the documentation and made the following changes.