a refactoring idea to rewrite the `README`
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 32/100
- issue の種類
- リファクタリング
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- markdown
調査の方向性
README.md、CONTRIBUTING.md、および .vuepress/configs/ 内のパス定義から始めてください。移動を提案する前に、blog/、book/、commands/、contributor-book/、cookbook/、および言語ディレクトリがどのように参照されているかを確認してください。リポジトリに開発指向の README があり、英語のコンテンツが en/ 配下にあり、文書化されたすべてのパスの整合性が保たれていれば完了です。
索引モデルが issue の本文から書いたものです。
説明
hello there 👋 😋
i feel this website repository is mainly made for developers or people who click on the "Edit this page on GitHub" button in the footer.
the other day i was looking for contribution guidelines and ended up asking how to run the website locally on the discord...
i did not see the CONTRIBUTING.md file in the root of the repo 😭
in fact, i looked at the main README, looking for instructions but found none => this is because the main ./README.md file IS the
english frontpage of www.nushell.sh!
my idea
i propose to move the frontpage of the website to some other place than ./README.md and write a true development-oriented README.md
to:
- point to the website itself at www.nushell.sh
- point to the main
nushellrepo - explain in details how to contribute to this repo OR at least explicitely point to
CONTRIBUTING.md
some details
- i think the paths to all the pages
MDfiles are specified in.vuepress/configs/, right? - i propose to move
blog/,book/,commands/,contributor-book/andcookbook/to a newen/directory, leading to the following architecture:
.
├── CNAME
├── CONTRIBUTING.md
├── i18n-meta.json
├── i18n.nu
├── LICENSE
├── make_docs.nu
├── package.json
├── package-lock.json
├── README.md
├── assets/
├── de/
├── es/
├── en/
├── ja/
├── pt-BR/
├── snippets/
├── tr/
└── zh-CN/
and one more level details
.
├── CNAME
├── CONTRIBUTING.md
├── i18n-meta.json
├── i18n.nu
├── LICENSE
├── make_docs.nu
├── package.json
├── package-lock.json
├── README.md
├── assets
│ └── images
├── de
│ ├── README.md
│ └── book
├── es
│ ├── README.md
│ ├── book
│ └── contributor-book
├── en
│ ├── blog
│ ├── book
│ ├── commands
│ ├── contributor-book
│ └── cookbook
├── ja
│ ├── README.md
│ └── book
├── pt-BR
│ ├── README.md
│ ├── book
│ └── contributor-book
├── snippets
│ ├── installation
│ ├── introduction
│ └── moving_around
├── tr
│ ├── README.md
│ └── book
└── zh-CN
├── README.md
└── book
that way
- the english default channel would be just another language channel, even though the prefered one by default
- the repo would have a more homogenous structure
- we would be able to move the english frontpage from
README.mdtoen/README.md, as with the other languages - we would be able to write a true
READMEfor the website repo
i wanted to have some feedback before trying to refactor the website like this.
shouldn't be that much work, mainly changing paths, but ehe 😉
- 主要言語
- TypeScript
- スター
- 258
- フォーク
- 561
- 平均マージ
- 3時間 20分
- マージ済み PR(30日)
- 15
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
nushell/nushell.github.io のほかの issue
-
難易度 1/5 1〜3時間 初心者へのやさしさ 68/100
nushell/nushell.github.io#2081 · コメント 3 件 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 62/100
nushell/nushell.github.io#767 · コメント 1 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 58/100
nushell/nushell.github.io#2232 · コメント 1 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 58/100
nushell/nushell.github.io#2209 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 45/100
nushell/nushell.github.io#2194 ·
nushell/nushell.github.io の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
mksglu/context-mode#1200 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
jaegertracing/jaeger-ui#4506 ·
-
area:desktop area:ui bug platform:macos
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
anthropics/claude-code#96687 ·
-
good first issue
難易度 1/5 1時間未満 初心者へのやさしさ 95/100
AOSSIE-Org/DebateAI#582 · コメント 2 件 ·