fix: remove md that is incompatible with docs #1063
Conversation
| [^1]: <https://git-scm.com/book/en/v2/Customizing-Git-Git-Configuration#_core_autocrlf> | ||
| [^1]: https://git-scm.com/book/en/v2/Customizing-Git-Git-Configuration#_core_autocrlf |
There was a problem hiding this comment.
@jonaro00 do you recall why you changed this? Removing it fixes the parsing error in the docs, but it might be needed?
There was a problem hiding this comment.
Mainly due to markdown lint rules, but as you also have discovered, Mintlify's markdown parser does not even support comments (to disable rules)...
There was a problem hiding this comment.
In my other large docs PR, using Mintlify v3, I changed the Contributing sidebar item to be a link to CONTRIBUTING.md instead. Sacrificing the quality (graph etc) from GitHub's rendering to mirror it is a waste IMO. A contributor should not be afraid of starting out on a markdown file on GH.
There was a problem hiding this comment.
Yes, that is a very fair point, there certainly are some footguns, I encountered a few myself testing this. Our understanding was that they would support mermaid soon, but they must not have had time to integrate it yet. 😅
I will merge this for now so we fix the parsing error, but I think just linking to github is definitely worth considering. I'll ask Ivan if they replied about mermaid as well.
Description of change
This fixes the parsing error in the docs.
How has this been tested? (if applicable)
Tested with
yarn mintlify devin the docs repo on latest mintlify.