nushell / nushell/nushell.github.io

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

オープン
#845 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

documentation enhancement
主要言語
TypeScript
スター
258
フォーク
561
平均マージ
3時間 20分
マージ済み PR(30日)
15

説明

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

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

links、lynx、w3m などの CLI ブラウザで Nushell のウェブサイトのドキュメントページを確認し、JavaScript なしでナビゲーションとコンテンツがどのように表示されるかを特定します。books、commands、cookbook のページで、ページ上部付近にコンテンツが表示され、役立つナビゲーションリンクが少数あるか、コンテンツへスキップするリンクがあれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
javascript
領域
documentation
issue の種類
ドキュメント
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。