nushell / nushell/nushell.github.io

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

Ouverte
#845 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

documentation enhancement
Langage dominant
TypeScript
Étoiles
258
Forks
561
Merge moyen
3 h 20 min
PR mergées (30 j)
15

Description

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

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Examinez les pages de documentation du site web de Nushell dans un navigateur CLI tel que links, lynx ou w3m, et identifiez la manière dont leur navigation et leur contenu sont présentés sans JavaScript. C’est terminé lorsque les pages des livres, des commandes et du cookbook exposent le contenu près du haut de la page, avec un petit ensemble de liens de navigation utiles ou un lien pour accéder directement au contenu.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
javascript
Domaine
documentation
Type d'issue
Documentation
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.