DOCS: Create AboutCode doc system
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 30/100
- issue の種類
- ドキュメント
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- javascript, markdown
調査の方向性
まず、aboutcode.readthedocs.io/ にある既存のドキュメントと、issue でリンクされている Diátaxis フレームワークを確認します。プロジェクトドキュメント、README ファイル、CONTRIBUTING ファイル、リポジトリの説明について、提案する構成とガイダンスを定義します。ドキュメントシステムが公開され、AboutCode プロジェクトがどのように適用すべきかを説明していれば完了です。
索引モデルが issue の本文から書いたものです。
説明
To improve and standardize the documentation across AboutCode projects, we plan to implement a documentation system on https://aboutcode.readthedocs.io/. This system will consist of pages inspired by the Divio documentation system, which explains the Diátaxis framework and its application to AboutCode projects.
Beyond outlining how project docs should be structured it the docs system should also provide guidance on README, CONTRIBUTING and repository descriptions.
- 主要言語
- JavaScript
- スター
- 9
- フォーク
- 17
- 平均マージ
- 7時間 55分
- マージ済み PR（30日）
- 2
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
aboutcode-org/www.aboutcode.org のほかの issue
-
Making all post button.対応中かも @sarthaklole が 71 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
aboutcode-org/www.aboutcode.org#117 · コメント 3 件 ·
-
WWW: Reduce frequency of update-releases再び着手できるかも @johnmhoran が 51 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンci-workflow
難易度 2/5 1〜3時間 初心者へのやさしさ 45/100
aboutcode-org/www.aboutcode.org#180 · 担当者 1 名 ·
-
DOCS: Create new AboutCode stack diagram(s)再び着手できるかも @hixvikas が 53 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンdocumentation
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
aboutcode-org/www.aboutcode.org#166 · コメント 1 件 ·
-
WWW: Create About top level page?対応中かも @pombredanne が 154 日前に担当しました。 オープンwebsite
難易度 2/5 1〜3時間 初心者へのやさしさ 35/100
aboutcode-org/www.aboutcode.org#164 · リアクション 1 件 · 担当者 1 名 ·
-
WWW: Add Initiatives and grant Projects再び着手できるかも @mjherzog が 241 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンenhancement needs design website
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
aboutcode-org/www.aboutcode.org#141 · 担当者 1 名 ·
aboutcode-org/www.aboutcode.org の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 73/100
microsoft/monaco-editor#5563 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
メンテナーはふだん 1 日以内に返信
-
account: profile bug
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 5 日以内に返信
-
ai-driven-fuzzing bug claude Minor
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
linagora/cozy-client#1777 · コメント 1 件 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信