nushell / nushell/nushell.github.io

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

Offen
#845 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

documentation enhancement
Vorherrschende Sprache
TypeScript
Sterne
258
Forks
561
Ø Merge
3 Std. 20 Min.
Gemergte PRs (30 T.)
15

Beschreibung

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Überprüfe die Dokumentationsseiten der Nushell-Website in einem CLI-Browser wie links, lynx oder w3m und ermittle, wie ihre Navigation und Inhalte ohne JavaScript dargestellt werden. Die Aufgabe ist erledigt, wenn die Seiten zu Büchern, Befehlen und dem Cookbook den Inhalt nahe am Anfang zusammen mit einer kleinen Auswahl nützlicher Navigationslinks oder einem Link zum direkten Überspringen zum Inhalt zugänglich machen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.