Restructure docs directory

オープン
#1,849 コメント 3 件 リアクション 1 件 担当者 0 名 GitHub で見る

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

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
35/100
issue の種類
ドキュメント
明瞭さ
説明が足りない
活発さ
停滞
領域
documentation

調査の方向性

まず、既存のdocsディレクトリと関連するissue #1848を確認し、現在混在しているドキュメントの種類を特定します。ADRs、Read the Docsのコンテンツ、その他のドキュメントを区別する構成を定義します。カテゴリが明確に分離され、既存のドキュメントが引き続き漏れなく含まれていれば完了です。

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

説明

documentation low-prio

Description of issue or feature request:

Current behavior:
No clear distinction of different documentation types in docs directory.

Expected behavior:
Clear distinction of different documentation types in docs directory, e.g. along the following categories:

  • adr
  • rtd (e.g. see sphinx-quickstart dir scaffolding)
  • misc docs that are neither an adr, nor rendered on rtd (?)

related: see #1848

主要言語
Python
スター
1.7k
フォーク
304
平均マージ
1日 2時間
マージ済み PR(30日)
17

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

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

はじめの一歩

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

theupdateframework/python-tuf のほかの issue

theupdateframework/python-tuf の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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