Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

installation: unclear + bugs

Aperta
  • Qualcosa non va?
#338 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
react, typescript
Ambito
documentation, frontend

Direzione di ricerca

Inizia esaminando la voce Install del menu superiore e le pagine in /doc, /doc/start, /doc/usage e /doc/install. Confronta il modo in cui viene presentata l’installazione e il comportamento del menu al passaggio del mouse e al clic; il lavoro è completato quando la navigazione e le istruzioni per l’installazione sono chiare e coerenti per i nuovi utenti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

A: website bug documentation

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?

Lingua principale
TypeScript
Stelle
13
Fork
22
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di iterative/cml.dev

Tutte le issue di iterative/cml.dev

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.