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

installation: unclear + bugs #338

Open
jorgeorpinel opened this issue Oct 10, 2022 · 0 comments
Open

installation: unclear + bugs #338

jorgeorpinel opened this issue Oct 10, 2022 · 0 comments
Labels
A: website Area: website bug Something isn't working documentation Markdown files

Comments

@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Oct 10, 2022

CML "installation" is somewhat confusing, esp. to first-time users, I believe.

  1. First, the Install element of the top website menu has some issues:
  • It opens on hover but closes on click. Should at least have a little triangle (like Other Tools) to make it more intuitive because I immediately want to click on it (like Docs or Blog), which just closes it -- this may happen so fast you don't even see it ever open (bad UX).
  • Once open (on hover) there's a gap so if you move the mouse too slow toward it, it actually closes again.
  • The "as a package" distinction is probably lost completely for most people. I think it implies that you don't usually want to install CML directly right?
  • Should it even be there if it's not a common need?
  1. Then once you get to https://cml.dev/doc there's no clear indication of where/how CML gets installed. It's indirectly mentioned in a few places that it's included in the Docker images provided but I think we should be more explicit about this in intro docs like the https://cml.dev/doc/start index page and/or https://cml.dev/doc/usage

  2. https://cml.dev/doc/install : is it linked from anywhere other than the top menu? I.e. why would I want to install CML as a a package?

@jorgeorpinel jorgeorpinel added documentation Markdown files A: website Area: website bug Something isn't working labels Oct 10, 2022
@jorgeorpinel jorgeorpinel changed the title install: unclear + bugs installation: unclear + bugs Oct 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A: website Area: website bug Something isn't working documentation Markdown files
Projects
None yet
Development

No branches or pull requests

1 participant