search

ControlSystemStudio / phoebus

A framework and set of tools to monitor and operate large scale control systems, such as the ones in the accelerator community.
http://phoebus.org/
Eclipse Public License 1.0
90 stars 89 forks source link

Documentation pointing to /latest/, but /stable/ documentation seems better #3160

Open PelloUsabiaga opened 3 weeks ago

PelloUsabiaga commented 3 weeks ago

Hi, I just want to point that the default link to the docs points to the /latest/ documentation, which, at least in my opinion, is much worse than the one in /stable/. I don't know if this is the expected behaviour, or if it has been discussed before, and if the /latest/ one is the one that wants to be displayed to new users like myself, but if it is not, consider changing it.

Thank you!

shroffk commented 3 weeks ago

Can you help us identify where the latest documentation diverges ( and worsens ) from the stable documentation. We should be able to easily switch to a stable release, but I would like to keep the latest documentation as clean and useable as possible (since the latest will become the next stable with the upcoming release )

PelloUsabiaga commented 2 weeks ago

I have been reviewing a little, and I am sorry, I have to retire what I said about that it is much worse. It has been mainly my problem, because I was not able to find the different pages of the documentation and their contents efficiently. The contents are, indeed, similar and I guess that more updated on the /latest/ version. But the index on the left lateral of the page does really help to navigate the docs and check its contains, without the need to constantly go back to the index page. I guess you have had your reasons to switch the sphinx theme, but at least in my opinion, the previous one had a better look and feel, and if you can introduce the lateral index back the new one would be much more navigable.

Thank you by the way for the amazing tool phoebus is! I have been testing it, and it works very smoothly!

shroffk commented 2 weeks ago

introduce the lateral index back the new one would be much more navigable

I think I agree with you, we should try to get the lateral index back

image