Closed Electric108 closed 5 months ago
I don't encourage the use of MDX (.mdx
) unless you know exactly what you're doing. If you're just doing regular documentation, regular Markdown (.md
) is sufficient.
Some of the cons of using MDX include:
However, if you really want to use MDX, please read the documentation here. I also encourage you write your documentation in Markdown first, and then transition to MDX to make use of the extensions' features.
Also... if your work will take a bit longer than a lab meeting, please branch out from dev
, as per the git policies.
A general guideline is:
- Nobody pushes to
main
, it can only be merged into- Push to
dev
only if it's a quick feature/fix- Push to your custom branch if it's something that will take a while to finish (i.e., won't be finished in a single sitting) and then merge it into
dev
The reason we do this is because if anybody else wants to make a quick change to dev
, their changes will appear on this PR, making it a bit complicated to figure out what work is meant for what feature.
So in this case, please make a new branch (name it whatever you'd like), and then request it to be merged into dev
. Closing this PR for now.
The is the eningeering documentation ( not complete yet) to be implemented. It will include: