Skip to content

Improve docs accessibility#676

Open
Hrovatin wants to merge 84 commits intomainfrom
docs/easy_access
Open

Improve docs accessibility#676
Hrovatin wants to merge 84 commits intomainfrom
docs/easy_access

Conversation

@Hrovatin
Copy link
Copy Markdown
Collaborator

@Hrovatin Hrovatin commented Oct 23, 2025

This PR tackles some points from #598, focused on #598 (comment) as agreed on the team meeting

Link to the built documentation
I still have issues with displaying images, will investigate this.

@Hrovatin Hrovatin marked this pull request as draft October 23, 2025 14:41
@Hrovatin Hrovatin marked this pull request as ready for review October 24, 2025 14:42
@Scienfitz

This comment was marked as outdated.

Comment thread docs/faq.md Outdated
Comment thread README.md Outdated
Comment thread README.md
Comment thread docs/userguide/userguide.md
@AVHopp

This comment was marked as outdated.

@AVHopp

This comment was marked as outdated.

AVHopp

This comment was marked as resolved.

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread docs/_static/quick_start_light.svg Outdated
Comment thread docs/faq.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
AdrianSosic

This comment was marked as resolved.

Comment thread docs/_static/quick_start_dark.svg Outdated
Copilot AI review requested due to automatic review settings December 17, 2025 09:58

This comment was marked as resolved.

@AVHopp AVHopp requested a review from Copilot January 7, 2026 12:41

This comment was marked as resolved.

@Hrovatin
Copy link
Copy Markdown
Collaborator Author

@Scienfitz done, built docs here: https://hrovatin.github.io/baybe/latest/

Copy link
Copy Markdown
Collaborator

@AVHopp AVHopp left a comment

Choose a reason for hiding this comment

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

Only one very minor thing, but other than that I'd say merge 🚀

Comment thread docs/scripts/graphics/landscape.py
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

why has this figure been touched? optimize or something?
(we'll have to redo all figures once we release new priors in the next release anyway)

Copy link
Copy Markdown
Collaborator Author

@Hrovatin Hrovatin Apr 1, 2026

Choose a reason for hiding this comment

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

It seems it was missed from the miniPR https://github.com/emdgroup/baybe/pull/726/changes
I can make one more miniPR with that image specifically @Scienfitz
What I changed is that it switches automatically based on browser defaults - before it was anyway static lightmode, so even if this does not work with website toggle, it is still better than before.
Ideal in future you could make it colored so that it works on light/dark without switch

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

wait this a figure coming from the full lookupe xamnple, it is automatically created when running that example in fulltest mode

have yu made any cahgens to that? did you manually add or modify it somehow? I dont think the procedure how pictures from examples are generated should be changed by this PR, especially if its not automated

Copy link
Copy Markdown
Collaborator Author

@Hrovatin Hrovatin Apr 11, 2026

Choose a reason for hiding this comment

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

yes, I made manual changes by merging the two light and dark mode versions into single file.

I reverted the change (removed the new plot) for now, using only light version, and we can later decide if we want to automate it.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

i dont really support this manual change because

  • there is other doc figures for which you've not done it (outside of readme and this picture also originates from outside thee readme)
  • your changes will be swiftly overwritten in case someone else redoes the figures, eg when we release the new version because this picture is the result of an example

So I see two ways forward

  1. do not do such a manual change on figures that stem from outside the readme
  2. put the logic you used to modify this picture in the relevant place so it is automatically repeated and not forgotten, I am not 100% sure but maybe the helper function create_example_plots from examples/utils.py which is used in the examples can be modified?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

@Scienfitz I would suggest that we move discussion on automating light+dark merging to a different issue, if required (since I removed it now). And for now (this PR) do one of the following:

  • a.) Use the light only figure (current PR version).
  • b.) I change the script that generates the plot to generate a gray version (besides light and dark) that we use in readme. I think this may be even better than merging as it is most robust (merging does not work with the light/dark toggle on the website).

Comment thread README.md Outdated
Comment thread README.md
Comment thread README.md Outdated
Comment thread README.md
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Hrovatin and others added 2 commits April 1, 2026 16:43
Co-authored-by: Martin Fitzner <martin.fitzner@merckgroup.com>
@Hrovatin Hrovatin requested a review from Scienfitz April 1, 2026 15:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants