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

Suggestion: Display the ReactFlow Version in the Documentation #652

Open
1 task done
SebasQuirogaUCP opened this issue Jan 21, 2025 · 1 comment
Open
1 task done

Comments

@SebasQuirogaUCP
Copy link

Code of Conduct

Which site are you suggesting a change for?

reactflow.dev

What content is affected by this change?

https://reactflow.dev/learn/customization/theming
https://reactflow.dev/learn

What part(s) of the article would you like to see updated?

Hi team,

I noticed that the current ReactFlow documentation does not provide a clear indication of the version it applies to. This can lead to confusion, especially for users working with different versions of ReactFlow.

For instance, I recently encountered an issue where I attempted to import styles using:

import '@xyflow/react/dist/style.css'; // Intended for version 12

However, my project was using ReactFlow version 11. After some trial and error and manual inspection, I discovered the correct path for version 11 was:

import '@reactflow/core/dist/style.css';

This discrepancy caused unnecessary debugging time, and I suspect other users may face similar challenges.

Suggestion:

Adding the ReactFlow version prominently in the documentation (e.g., at the top of each page or in a dedicated section) would help users quickly verify compatibility and reduce the likelihood of trying incorrect code.

Thank you for considering this enhancement! It would make an already excellent library even more user-friendly.

Best regards,

Additional information

No response

@moklick
Copy link
Member

moklick commented Jan 21, 2025

We serve the old docs from sub domains: v9.reactflow.dev, v10.reactflow.dev, v11.reactflow.dev but I agree that it would be nice to have a version switch. Maybe we could make it easier to find the old versions 🤔 We will think about it!

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

2 participants