web Suggestion: Display the ReactFlow Version in the Documentation

Suggestion: Display the ReactFlow Version in the Documentation

Open SebasQuirogaUCP opened this issue 10 months ago • 1 comments

trafficstars

Code of Conduct

[x] I have read and agree to the xyflow contributor 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

Jan 21 '25 18:01 SebasQuirogaUCP

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!