Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unsolicited feedback on docs #225

Open
sgbaird opened this issue Jun 23, 2023 · 0 comments
Open

Unsolicited feedback on docs #225

sgbaird opened this issue Jun 23, 2023 · 0 comments

Comments

@sgbaird
Copy link
Contributor

sgbaird commented Jun 23, 2023

First, I'm excited to see the updates and interest from the community evolving! :)

Various feedback as I was going through the recent documentation:

  • Edit on GitHub button would be nice
  • Nice on the light vs. dark mode
  • add "next" or "move to next page" buttons at the end of each page
  • While looking at the landing page, it struck me that it was only text and formulas. Not saying add "color" (figures, etc.) without a good reason, but a few possibilities of things to add:
    • some kind of logo or graphical abstract in the introduction section?
    • "Figure 1" -style figure with the various functionalities that make BoFire distinct. This could also look like a code/features diagram. For example, something like Figure 1 from Olympus 2.0, though probably higher-level. This might go well in the "Experimental design" subsection
    • A classic Pareto front teaching figure for the "Multi-objective optimization" subsection
  • consistency between use of "Bofire" vs. "BoFire" in text (aside from when referring to the Python package explicitly) minor capitalization fix #224 (same with BoTorch, PyTorch, etc.)
  • Consider adding a "related packages" section on the landing page (or provide a link to a separate page and add it there), and clarifying what makes BoFire unique. I think it's worth mentioning Ax, Olympus (e.g., BoTorch planner, which I think is https://github.com/rileyhickman/atlas), and maybe Gauche. Maybe
  • Add an "Open In Colab" badge to the top of the ipynb notebooks (at least the "Getting started" notebook). I like to verify that the main public-facing tutorial runs to completion as part of GitHub actions. See e.g., https://github.com/sparks-baird/self-driving-lab-demo/blob/0e59ea8ae6adb028b2ad550b40cc562f6d3b0f27/.github/workflows/ci.yml#L109-L113
  • I like the Getting Started notebook!

p.s., I'm watching the repository's "releases" and "discussions" 🤗

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

No branches or pull requests

1 participant