-
-
Notifications
You must be signed in to change notification settings - Fork 5
docs: add mermaid diagrams redo #521
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
base: main
Are you sure you want to change the base?
Changes from 13 commits
cc66323
9a32a98
f16f94d
07352bc
21ec283
603d2a0
95557a1
feca8f2
2ae87de
aad4695
1a53514
655f819
6ea4bfc
efef520
88b34c7
53e46db
212aae4
6d8492e
f0e66f6
b76028b
25f572b
cd80ccb
9af724c
1916ecc
f8d3ad4
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,17 +17,18 @@ | |
| "check": "prettier --ignore-unknown --list-different --check ." | ||
| }, | ||
| "dependencies": { | ||
| "@docusaurus/core": "3.7.0", | ||
| "@docusaurus/preset-classic": "3.7.0", | ||
| "@docusaurus/core": "3.9.2", | ||
| "@docusaurus/preset-classic": "3.9.2", | ||
| "@docusaurus/theme-mermaid": "3.9.2", | ||
| "@mdx-js/react": "^3.0.0", | ||
| "clsx": "^2.0.0", | ||
| "prism-react-renderer": "^2.3.0", | ||
| "react": "^19.0.0", | ||
| "react-dom": "^19.0.0" | ||
| "react": "^18.3.1", | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What's going on here?
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Hey @BekahHW. When I was working on the PR, the mermaid diagram feature was not working initially due to compatibility issues, so I had to downgrade React from 19 to 18.3.1. I also changed the order of the diagrams like you asked. Here they are
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm not super comfortable downgrading the version. Can you explore some other solutions and present them?
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Hi @BekahHW, Thanks for the feedback! I did some exploring and it turns out the problem isn't really about version compatibility at all. The Docusaurus Mermaid theme is looking for an optional dependency called As far as solutions, here's what I came up with: Option 1: Add the missing dependency pnpm add @mermaid-js/layout-elkThis would be the simplest fix - just installing what the theme is expecting to find. Option 2: Upgrade to the latest Docusaurus version pnpm add @docusaurus/core@latest @docusaurus/preset-classic@latest @docusaurus/theme-mermaid@latestSometimes, newer versions have better dependency handling. Option 3: Convert to static images Option 4: Disable the ELK layout feature Personally, I think Option 1 would be suited to solve your concern. It's the most straightforward and keeps everything working as intended. What do you think?
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
| "react-dom": "^18.3.1" | ||
| }, | ||
| "devDependencies": { | ||
| "@docusaurus/module-type-aliases": "3.7.0", | ||
| "@docusaurus/types": "3.7.0", | ||
| "@docusaurus/module-type-aliases": "3.9.2", | ||
| "@docusaurus/types": "3.9.2", | ||
| "prettier": "^2.2.1" | ||
| }, | ||
| "browserslist": { | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the way these look and how you can open and close. I would put them under the proper heading. For instance, you have all the drop downs at the top, but the CFP diagram should go in the CFP section. That helps to keep the info organized in a logical way. Otherwise the right nav for the page gets super confusing. You have the same thing 2x and you have something that says Post-Event and then CFP comes after that.
If some of those don't have their own section rn, just move them to where they'd make sense chronologically. But really like how these have turned out!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Made the changes. What do you think?