DOCS: Create AboutCode doc system
還沒有人認領這個 Issue。
評估
- 難度
- 5/5
- 預估耗時
- 一週以上
- 新手友好度
- 30/100
- Issue 類型
- 文件
- 描述清晰度
- 需要釐清
- 活躍度
- 停滯
- 技術堆疊
- javascript, markdown
研究方向
先檢視 aboutcode.readthedocs.io/ 上現有的文件，以及 issue 中連結的 Diátaxis 框架。定義專案文件、README 檔案、CONTRIBUTING 檔案和 repository 描述的建議結構與指引；當文件系統發布，並說明 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 分鐘
- 30 天內合併 PR
- 2
環境準備
這個專案沒有提供開發容器、Dockerfile 或貢獻指南，環境需要你自己搭建：先看它的 README，通用步驟見我們的新手貢獻指南。
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
aboutcode-org/www.aboutcode.org 的其他 Issue
-
Making all post button.可能已有人在做 @sarthaklole 於 72 天前認領。 未關閉
難度 2/5 1-3 小時 新手友好度 72/100
aboutcode-org/www.aboutcode.org#117 · 3 則留言 ·
-
WWW: Reduce frequency of update-releases可能重新可做 @johnmhoran 於 53 天前認領，目前沒有進行中的 PR。 未關閉ci-workflow
難度 2/5 1-3 小時 新手友好度 45/100
aboutcode-org/www.aboutcode.org#180 · 已指派 1 人 ·
-
DOCS: Create new AboutCode stack diagram(s)可能重新可做 @hixvikas 於 55 天前認領，目前沒有進行中的 PR。 未關閉documentation
難度 5/5 一週以上 新手友好度 35/100
aboutcode-org/www.aboutcode.org#166 · 1 則留言 ·
-
WWW: Create About top level page?可能已有人在做 @pombredanne 於 156 天前認領。 未關閉website
難度 2/5 1-3 小時 新手友好度 35/100
aboutcode-org/www.aboutcode.org#164 · 1 個 reaction · 已指派 1 人 ·
-
WWW: Add Initiatives and grant Projects可能重新可做 @mjherzog 於 243 天前認領，目前沒有進行中的 PR。 未關閉enhancement needs design website
難度 5/5 一週以上 新手友好度 25/100
aboutcode-org/www.aboutcode.org#141 · 已指派 1 人 ·
查看 aboutcode-org/www.aboutcode.org 的全部 Issue
相似的 Issue
-
[quality] /resources/metrics draws the single-point member-companies chart on the left axis可能已有人在做 @hivecommons-hive 今天認領。 未關閉agent/quality stage/040-covered-by-pr testing
難度 1/5 1 小時以內 新手友好度 88/100
維護者通常 1 天內回覆
-
Difficulty: Easy Good First Issue Help Wanted javascript
難度 2/5 1-3 小時 新手友好度 72/100
rubyforgood/casa#7311 ·
維護者通常 1 天內回覆
-
check:failed logos:edit
難度 1/5 1 小時以內 新手友好度 70/100
iptv-org/database#38883 · 1 則留言 ·
維護者通常 4 天內回覆
-
難度 2/5 1-3 小時 新手友好度 72/100
維護者通常 1 天內回覆
-
Start: a `+` in the project path leaks server code into the client build (unescaped `new RegExp(routeTreePath)`), and memory grows without limit可能已有人在做 @Sheraff 於 6 天前認領。 未關閉
難度 2/5 1-3 小時 新手友好度 62/100
TanStack/router#8839 · 1 則留言 ·
維護者通常 1 天內回覆