Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Syntax error in graph mermaid version 8.8.0 on SoilInterface docs page #259

Open
turbomam opened this issue Nov 6, 2024 · 3 comments
Open
Assignees

Comments

@turbomam
Copy link
Member

turbomam commented Nov 6, 2024

https://microbiomedata.github.io/submission-schema/SoilInterface/

image

I think this may be related to the size of the Mermaid diagram, but I don't know whether that is based on the number of edges, the size of the generated Mermaid URL, etc.

@sujaypatil96 developed some mechanism for refusing to generate a problematic image and providing the user with a more helpful message. I don't know what it would take to implement that here.

I think @eecavanna observed this in some other repo, but I can't find that now

@turbomam
Copy link
Member Author

turbomam commented Nov 7, 2024

https://microbiomedata.github.io/nmdc-schema/Biosample/ is an example where the documentation generator gracefully declined to generate a Mermaid diagram

https://microbiomedata.github.io/nmdc-schema/Biosample/

"Mermaid class diagram too large to render."

@eecavanna
Copy link
Contributor

I looked at the source code of the problematic HTML page (via "View Source" in my web browser) and saw that the Mermaid code has some "HTML entities" where I expect to see the "raw" characters.

image

I'd recommend checking whether the code that generates the Mermaid code and injects it into the HTML file, has changed recently. Are other pages of the docs broken like this, or only the SoilInterface one?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants