Skip to content

Conversation

@MakisH
Copy link
Member

@MakisH MakisH commented Dec 18, 2024

Do we really need the version number in the sidebar?

Screenshot from 2024-12-18 13-28-52

  • It is not very accurate: We sometimes include forward-referencing content, and it is not fixed at the time of the respective release.
  • It is misleading: users think that they can click somewhere to change that (user observation at the SSE).
  • It is yet another hard-coded place to update.

This PR removes the version and expands "Docs" to "Documentation".

I have not tested how this change renders.

Do we really need the version number in the sidebar?

![Screenshot from 2024-12-18 13-28-52](https://github.com/user-attachments/assets/b9ee68b6-95a4-43d1-8001-33c7df80a43c)

- It is not very accurate: We sometimes include forward-referencing content, and it is not fixed at the time of the respective release.
- It is misleading: users think that they can click somewhere to change that (user observation at the SSE).
- It is yet another hard-coded place to update.
@MakisH MakisH self-assigned this Dec 18, 2024
Copy link
Member

@uekerman uekerman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am OK with the change, but neither have tested the rendering.
Further problem: The docs is not only preCICE, but many components with different versions. The "last edited on" feature is much more transparent than this.

@MakisH MakisH merged commit 8ba066b into master Dec 19, 2024
2 checks passed
@MakisH MakisH deleted the sidebar-version branch December 19, 2024 10:07
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

Successfully merging this pull request may close these issues.

3 participants