Improve the user flow for editing the (autogenerated) docs

オープン

#1,722 2024年12月29日に作成コメント 1 件リアクション 2 件担当者 0 名 GitHub で見る

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

評価

難易度: 4/5
見積もり時間: 3〜5日
初心者へのやさしさ: 35/100

issue の種類: ドキュメント
明瞭さ: おおむね明確
活発さ: 停滞
技術スタック: github
領域: documentation

調査の方向性

まず README.md と CONTRIBUTING.md を読み、その後、Web サイトが「Edit this page on GitHub」リンクを追加する方法と、GitHub issue template の設定方法を調べます。編集すべきでないページにこれらのリンクが表示されなくなり、issue template が自動生成されたパスを識別し、README.md がコントリビューターをコントリビューションガイダンスに案内するようになれば、作業は完了です。

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

説明

The Nushell website has links at the bottom of the page to "Edit this page on GitHub". Clicking the link takes the user through the process of updating that page using the GitHub web interface to create a pull request. That user flow bypasses the CONTRIBUTING.MD and it's not until after the PR is submitted the user is notified about not updating autogenerated docs.

Some suggestions to improve this for first time contributors.

Remove the "Edit this page on GitHub" links on pages that should not be edited.
Change or create the GitHub issue template specifying that certain pages, trees roots or paths should not be modified.
Add a note about contributing to the README.md. As it is, the user is expected to know about the CONTRIBUTING.md document.

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

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

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

はじめの一歩

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

nushell/nushell.github.io のほかの issue

`--log-level` isn't documented in documentation for flags オープン

難易度 1/5 1〜3時間初心者へのやさしさ 68/100

nushell/nushell.github.io#2081 · コメント 3 件 · 2025年11月25日に作成
[ja] fix statement about lines output type オープン

難易度 1/5 1時間未満初心者へのやさしさ 62/100

nushell/nushell.github.io#767 · コメント 1 件 · 2023年2月4日に作成
The cookbook example "Accessing HTTP Response Metadata While Streaming" doesn't stream オープン

難易度 3/5 1〜2日初心者へのやさしさ 58/100

nushell/nushell.github.io#2232 · コメント 1 件 · 2026年8月24日に作成
Color scheme toolbar button does not apply to code samples オープン

難易度 3/5 1〜2日初心者へのやさしさ 58/100

nushell/nushell.github.io#2209 · 2026年7月19日に作成
Pages won't load after a period of time オープン

難易度 4/5 3〜5日初心者へのやさしさ 45/100

nushell/nushell.github.io#2194 · 2026年7月5日に作成

nushell/nushell.github.io の issue をすべて見る

似ている issue

bug(cli): hapi doctor inline-media prints a fabricated B:\ helper-script path in packaged installs オープン

難易度 2/5 1〜3時間初心者へのやさしさ 70/100

tiann/hapi#1918 · コメント 1 件 · 2026年9月24日に作成
Crush オープン

難易度 1/5 1時間未満初心者へのやさしさ 85/100

catppuccin/catppuccin#3125 · 2026年9月24日に作成
Add a SECURITY.md オープン

難易度 1/5 1時間未満初心者へのやさしさ 90/100

ElementsProject/cln-application#167 · コメント 1 件 · リアクション 1 件 · 2026年9月24日に作成
Dependencies whose license text can't be resolved are silently dropped from the output オープン

難易度 2/5 1〜3時間初心者へのやさしさ 75/100

Quantco/pnpm-licenses#17 · 2026年9月24日に作成
EV search minPowerKW filters out every station that reports connectors オープン

難易度 2/5 1〜3時間初心者へのやさしさ 75/100

tomtom-international/tomtom-maps-mcp#284 · 2026年9月24日に作成

TypeScript の issue をもっと見る