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

docs: optimize code preview in docs #1253

Draft
wants to merge 14 commits into
base: main
Choose a base branch
from

Conversation

zetareticoli
Copy link
Member

@zetareticoli zetareticoli commented Oct 17, 2024

Descrizione

Ridotto il font-size e lo spacing del tag <code> nella documentazione per ottimizzare la lettura di lunghi blocchi di codice e ridurre lo spazio verticale occupato.

Rivisto il posizionamento del pulsante "Copia" per i blocchi di codice.

Checklist

Copy link

vercel bot commented Oct 17, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
bootstrap-italia ✅ Ready (Inspect) Visit Preview Dec 2, 2024 1:28pm

@zetareticoli zetareticoli changed the title feat: optimize code spacing and font size feat: optimize code preview in docs Oct 17, 2024
Copy link
Member

@astagi astagi left a comment

Choose a reason for hiding this comment

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

@zetareticoli il problema adesso del bottone riguarda lato mobile il fatto che copre il codice in alcune sezioni, per questo era stato spostato più a destra e nell'angolo

@zetareticoli
Copy link
Member Author

@zetareticoli il problema adesso del bottone riguarda lato mobile il fatto che copre il codice in alcune sezioni, per questo era stato spostato più a destra e nell'angolo

avevo fatto diverse prove su vari componenti, perché ora il codice ha un font-size ridotto e va a capo dopo un tot di lunghezza (così da non dover scrollare orizzontalmente ogni volta).

In quali componenti hai visto sovrapposizione?

@astagi
Copy link
Member

astagi commented Oct 31, 2024

@zetareticoli il problema adesso del bottone riguarda lato mobile il fatto che copre il codice in alcune sezioni, per questo era stato spostato più a destra e nell'angolo

avevo fatto diverse prove su vari componenti, perché ora il codice ha un font-size ridotto e va a capo dopo un tot di lunghezza (così da non dover scrollare orizzontalmente ogni volta).

In quali componenti hai visto sovrapposizione?

@zetareticoli il problema si presenta più che altro lato mobile, ad esempio

image

@astagi astagi added the docs Issue e PR che riguardano la documentazione label Nov 4, 2024
@zetareticoli
Copy link
Member Author

@zetareticoli il problema adesso del bottone riguarda lato mobile il fatto che copre il codice in alcune sezioni, per questo era stato spostato più a destra e nell'angolo

avevo fatto diverse prove su vari componenti, perché ora il codice ha un font-size ridotto e va a capo dopo un tot di lunghezza (così da non dover scrollare orizzontalmente ogni volta).
In quali componenti hai visto sovrapposizione?

@zetareticoli il problema si presenta più che altro lato mobile, ad esempio

image

Ok, vedo di fare nuovi test

@zetareticoli
Copy link
Member Author

@zetareticoli il problema adesso del bottone riguarda lato mobile il fatto che copre il codice in alcune sezioni, per questo era stato spostato più a destra e nell'angolo

avevo fatto diverse prove su vari componenti, perché ora il codice ha un font-size ridotto e va a capo dopo un tot di lunghezza (così da non dover scrollare orizzontalmente ogni volta).
In quali componenti hai visto sovrapposizione?

@zetareticoli il problema si presenta più che altro lato mobile, ad esempio

image

Possiamo rimuoverlo da mobile (50a255d) considerato che il "copy" serve per scenari di editing su device medio-grandi

@Fupete
Copy link
Contributor

Fupete commented Nov 5, 2024

Possiamo rimuoverlo da mobile (50a255d) considerato che il "copy" serve per scenari di editing su device medio-grandi

Torna anche a me. Ragionando a voce alta: ma se usassimo — magari solo su mobile, ma ci starebbe anche su desktop — un pulsante meno ingombrante? Ad esempio solo icona come sul sito Designers Italia?
immagine

E, seconda idea, ma se rendessimo "collassabili" questi blocchi di codice più che usare un font-size piccolo? Non vorrei infatti che con il testo troppo piccolo diventassero poco inclusivi per developer con una vista non ottima.

@Fupete
Copy link
Contributor

Fupete commented Nov 5, 2024

@zetareticoli occhio che la preview con l'ultimo commit si è "rotta"
immagine

@zetareticoli
Copy link
Member Author

Possiamo rimuoverlo da mobile (50a255d) considerato che il "copy" serve per scenari di editing su device medio-grandi

Torna anche a me. Ragionando a voce alta: ma se usassimo — magari solo su mobile, ma ci starebbe anche su desktop — un pulsante meno ingombrante? Ad esempio solo icona come sul sito Designers Italia? immagine

E, seconda idea, ma se rendessimo "collassabili" questi blocchi di codice più che usare un font-size piccolo? Non vorrei infatti che con il testo troppo piccolo diventassero poco inclusivi per developer con una vista non ottima.

👍 per il pulsante copia come su Designers Italia, almeno usiamo lo stesso stile. Quel pulsante (icona compresa) provengono da BSI?

Quello che mi sembrava difficile da usare erano le barre di scorrimento orizzontale e verticale per scorrere tutto il codice, rimpicciolendo font e applicando un max-width all'area di testo in codice almeno ti costringe a scorrere solo in una direzione.

@Fupete
Copy link
Contributor

Fupete commented Nov 5, 2024

Possiamo rimuoverlo da mobile (50a255d) considerato che il "copy" serve per scenari di editing su device medio-grandi

Torna anche a me. Ragionando a voce alta: ma se usassimo — magari solo su mobile, ma ci starebbe anche su desktop — un pulsante meno ingombrante? Ad esempio solo icona come sul sito Designers Italia? immagine
E, seconda idea, ma se rendessimo "collassabili" questi blocchi di codice più che usare un font-size piccolo? Non vorrei infatti che con il testo troppo piccolo diventassero poco inclusivi per developer con una vista non ottima.

👍 per il pulsante copia come su Designers Italia, almeno usiamo lo stesso stile. Quel pulsante (icona compresa) provengono da BSI?

Quello che mi sembrava difficile da usare erano le barre di scorrimento orizzontale e verticale per scorrere tutto il codice, rimpicciolendo font e applicando un max-width all'area di testo in codice almeno ti costringe a scorrere solo in una direzione.

Sì sì concordo con te. Su Designers abbiamo aggiunto il checkbox per fare il "soft-wrap". Sarebbe da capire se farlo anche qui magari... chissà se è fattibile.

@Fupete
Copy link
Contributor

Fupete commented Nov 5, 2024

Il pulsante su DI fondamentalmente è un button con qualche styling ulteriore per renderlo più piccolo.

Così dovrebbe funzionare:

<button class="btn btn-xs btn-primary p-2" type="button" data-focus-mouse="false">
  <span>
    <svg role="img" class="icon icon-sm icon-white align-middle" aria-label=" Copia il codice negli appunti">
    <use href="/svg/sprites.svg#it-copy"></use></svg>
  </span>
</button>

Lo possiamo anche semplificare se serve.

@astagi astagi changed the title feat: optimize code preview in docs docs: optimize code preview in docs Nov 5, 2024
@astagi astagi marked this pull request as draft November 5, 2024 16:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issue e PR che riguardano la documentazione enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants