[EmioLabs] create your own lab: adds section with predefined modules#64
Open
HanaeRateau wants to merge 1 commit into
Open
[EmioLabs] create your own lab: adds section with predefined modules#64HanaeRateau wants to merge 1 commit into
HanaeRateau wants to merge 1 commit into
Conversation
HanaeRateau
changed the title
Comment on lines
+68
to
+72
| Using the <a href="#include">`#include`</a> syntax, you can include files in your markdown file for better resusability and modularity. For example, you can create a file `assets/labs/mylab/parameters.md` containing explanations about parameters you use for your lab and include it in your main markdown file with: | ||
|
|
||
| ```markdown | ||
| #include("assets/labs/mylab/parameters.md") | ||
| ``` |
Contributor
There was a problem hiding this comment.
I'm wondering if this shouldn't be elsewhere. In the markdown syntax section perhaps?
| #include("assets/labs/mylab/parameters.md") | ||
| ``` | ||
|
|
||
| There are several predefined modules that you can include in your lab and visualize in the *Sandbox* lab. They are located in the `assets/labs/modules` directory: |
Contributor
There was a problem hiding this comment.
The "include" could link to the explanation (if moved)
| ``` | ||
|
|
||
| There are several predefined modules that you can include in your lab and visualize in the *Sandbox* lab. They are located in the `assets/labs/modules` directory: | ||
| - `assets/labs/modules/calibration.md` : contains the calibration parameters for the robots used in the labs |
Contributor
There was a problem hiding this comment.
Suggested change
| - `assets/labs/modules/calibration.md` : contains the calibration parameters for the robots used in the labs | |
| - `assets/labs/modules/calibration.md` : contains tools to calibrate the camera. |
EulalieCoevoet
added
the
documentation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Thi PR implement issue #56:
It adds a section in Create Your Own Lab that explains how to include predefined modules and lists them (calibration and beam resampler).
Note: In this PR, the
atag on the#includedoes not go anywhere because the ancchor does not exist yet (issue #65).