nushell / nushell/nushell.github.io

Please enhance the documentation for people using a CLI web browser, without JavaScript.

Aperta
#845 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

documentation enhancement
Lingua principale
TypeScript
Stelle
258
Fork
561
Merge medio
3h 20m
PR unite (30g)
15

Descrizione

Related problem

Hello, I maintain the Slint distribution https://slint.fr which is accessible to the blind.

Many blind users prefer to use the command line than a graphical environment and a use a CLI web browser like links, lynx or w3m that has no support for JavaScript. I have packaged nushell recently and folks using one of these browser find tedious to read the documentation, like books, commands or cookbook (you may want to try yourself) as they have to scroll down a lot before getting to the content.

Describe the solution you'd like

Have a version with just the content and a few links on top of it (like to go one or two levels up in the tree).

Describe alternatives you've considered

Provide a link on top of each page "skip to content".

Additional context and details

No response

Guida per i contributori

Apri la guida per i contributori

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.

Direzione di ricerca

Esamina le pagine della documentazione del sito web di Nushell in un browser CLI come links, lynx o w3m e identifica come vengono presentati la navigazione e i contenuti senza JavaScript. Il lavoro è completo quando le pagine di libri, comandi e cookbook mostrano i contenuti vicino all’inizio, insieme a un piccolo insieme di link di navigazione utili o a un link per passare direttamente al contenuto.

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

Valutazione

Stack tecnologico
javascript
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.