Skip to content

Improve docs accessibility#676

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

Improve docs accessibility#676
Hrovatin wants to merge 82 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.

@AVHopp

This comment was marked as outdated.

@AVHopp

This comment was marked as outdated.

AVHopp

This comment was marked as resolved.

AdrianSosic

This comment was marked as resolved.

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 🚀

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

README.md Outdated

BayBE provides a **general-purpose toolbox** for Bayesian Design of Experiments,
focusing on making this procedure easily accessible for real-world experiments.
Its utility was already shown in a variety of real-world experimental campaigns in both industry and academia.
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.

opportunity to link to the Citation section?

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.

Added, but I think we cite only our own paper there. Is that what you had in mind?


<div align="center">

![Quick Start](https://raw.githubusercontent.com/Hrovatin/baybe/docs/easy_access/docs/_static/quick_start.svg)
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.

the sue of grey seems strange in white mode, but I guess it was done to not have to make several bright/dark mode variants, is that right?

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.

Yes, since we couldn't find an option that works on both github (browser based) and website toggle

<li>Conduct AB testing via <a href="https://emdgroup.github.io/baybe/stable/examples/Multi_Armed_Bandit/Multi_Armed_Bandit.html">bandit models</a>.</li>
</ul>
</li>
<li>Define the optimal target value via <a href="https://emdgroup.github.io/baybe/stable/userguide/transformations.html">target transformations</a>.</li>
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.

define the optimal target value sounds strange to me, can we come up with a better wording?

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.

What about Specify what a “good” target value is

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.

@AVHopp @AdrianSosic any other ideas?

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