Documentation for the simulator #18
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
zahnooo
force-pushed
the
feature/doc-simulator
branch
from
c27ff6c to
81352d1
Compare
- Relative image paths - GitHub Alert syntax - HTML figure for image captions
r-dent
approved these changes
Feb 16, 2024
There was a problem hiding this comment.
Very nice graphics! I made some adjustments on the syntax, though:
- Use of relative paths for images. You can do that and it is actually recommended. You can now also preview the file with images.
- Use of GitHub-styled Alert blocks. GitHub renders them nicely. And i would expect that GitBook would do also.
- Use of
<figure>tag for image captions. I expect it to look better in GitLab that way (Docs).
I hope that's okay.
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.
No description provided.