Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Installation docs...

オープン 初心者向け
#57 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

評価

難易度
1/5
見積もり時間
1時間未満
初心者へのやさしさ
90/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
python
領域
documentation

調査の方向性

プロジェクトのdocsディレクトリ内の既存のインストールドキュメント(おそらく'getting-started'または'installation'の下)を確認してください。このissueは、pipとuvの両方に言及し、明確で中立的な例を提供するように指示を更新することを提案しています。現在のインストール手順についてはmkdocsのドキュメントを確認し、提案されたコマンド'python3 -m venv venv'、'venv/bin/pip install mkdocs'、'venv/bin/mkdocs'を含めるように修正し、uvのドキュメントへのリンクも追加してください。変更が正しいマークダウンファイルに行われていることを確認し、ドキュメントをローカルでビルドして検証してください。

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

説明

pip and uv

I suppose let's be staightforward when we can, and link out to step-by-step walk throughs for new comers when needed.

Most of what I'm seeing these days recommends uv and they've got good little docs to point towards.
If we're doc'ing pip then python3 -m venv venv ... venv/bin/pip install mkdocs ... venv/bin/mkdocs is a dependable route.

We might want to use slightly neutral "Install the mkdocs python package..." then the console example.

主要言語
Python
スター
32
フォーク
2
平均マージ
8時間 51分
マージ済み PR(30日)
15

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

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

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

encode/mkdocs のほかの issue

encode/mkdocs の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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