Determine how to handle Vuepress code snippets in docs
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 25/100
- issue の種類
- 機能追加
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- shell
調査の方向性
Book に既存する Vuepress のコードスニペット、それらの .sh ファイル、および対応する各言語の翻訳を確認します。ここで説明されているメンテナンスと構文ハイライトへの影響を比較します。完了の条件は、スニペットを残すか削除するか、また何を更新する必要があるかについて、明確な判断に到達し、それを文書化することです。
索引モデルが issue の本文から書いたものです。
説明
I just noticed that the Book uses some Vuepress code snippets in places (but not everywhere). There are some advantages and disadvantages to these:
Advantages:
- (Minor) Can be reused if needed
- (Nice) Indention is much easier if the code-block is nested under a list item
Disadvantages:
- (Major) All of the existing snippets are
.shfiles. These need to be updated to.nufiles in order to obtain proper syntax highlighting, of course. - (Major) Renaming or moving a snippet requires updates to all language translations, otherwise we are left with broken links.
- When a code snippet is updated, it is propagated across all language translations. This sounds nice, but that may not be desirable if the text around it needs to be updated as well, which will likely be the case.
- Probably won't be portable if we change backends in the future
When I first saw these, I liked the concept, but after dealing with the ramifications, it seems like they might be more problematic than helpful.
At the least, all of them have to be reworked to get syntax highlighting. Should this just be a single "eliminate Vuepress snippets" enhancement?
- 主要言語
- 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 件 ·