CRAVEX-Docs: Improve documentation
@pombredanne 已經在處理了。
開始於 2026年5月28日。
評估
- 難度
- 5/5
- 預估耗時
- 一週以上
- 新手友好度
- 25/100
- Issue 類型
- 文件
- 描述清晰度
- 需要釐清
- 活躍度
- 停滯
- 技術堆疊
- javascript, markdown, wordpress
- 領域
- content, documentation, web-dev
研究方向
首先，盤點 www.aboutcode.org repository 中現有的 Docusaurus/Markdown 內容，以及 issue 中描述的目前 WordPress 和 Read the Docs/Sphinx 網站。在進行任何變更之前，定義一個具有明確 getting-started 成果的小型文件增量；完成的標準應是已有一份可以接收社群回饋的已發佈指南或教學。
由索引模型根據 Issue 內容生成。
描述
We need improve the user experience in getting started with DejaCode and CRAVEX by updating the AboutCode.org website and the documentation of the AboutCode projects. We should also do an overhaul of the AboutCode's information architecture and supporting systems so it's easier to participate and contribute to AboutCode educational materials using a git-based workflow.
The goal of this new documentation issue is to provide a smooth "getting started" experience and comprehensive suite of guides with educational materials (e.g. tutorials) assisting users with CRA compliance using Dejacode CRAVEX features and AboutCode suite overall.
I suggest we execute this in small increments, creating and publishing the improved and new documentation after each increment, including code examples and other improvements as needed, closing each increment with a blog post that summarizes the new documentation so that we can get community feedback. For this let's track these issues:
Discussed also in https://github.com/orgs/aboutcode-org/discussions/195
Originally posted by pombredanne May 22, 2025
Hey, we need to up our game on the overall project docs and web site as I have received a lot of less positive feedback
Right now aboutcode.org is using wordpress and elementor
And the read the doc web sites are using Restructured text and Sphinx
The issues to me are:
- we can change the look and feel, but more importantly is the "architecture" of the information about the overall project and how to get started that is the most pressing issue
- we will need something that's based on text files in git repos, rather that wordpress which does not help much with participation
Inputs and suggestions and help are mucho welcomed. I am considering organizing a commando hackathon thing to get us started.
- 主要語言
- 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 於 71 天前認領。 未關閉
難度 2/5 1-3 小時 新手友好度 72/100
aboutcode-org/www.aboutcode.org#117 · 3 則留言 ·
-
WWW: Reduce frequency of update-releases可能重新可做 @johnmhoran 於 52 天前認領，目前沒有進行中的 PR。 未關閉ci-workflow
難度 2/5 1-3 小時 新手友好度 45/100
aboutcode-org/www.aboutcode.org#180 · 已指派 1 人 ·
-
DOCS: Create new AboutCode stack diagram(s)可能重新可做 @hixvikas 於 54 天前認領，目前沒有進行中的 PR。 未關閉documentation
難度 5/5 一週以上 新手友好度 35/100
aboutcode-org/www.aboutcode.org#166 · 1 則留言 ·
-
WWW: Create About top level page?可能已有人在做 @pombredanne 於 155 天前認領。 未關閉website
難度 2/5 1-3 小時 新手友好度 35/100
aboutcode-org/www.aboutcode.org#164 · 1 個 reaction · 已指派 1 人 ·
-
WWW: Add Initiatives and grant Projects可能重新可做 @mjherzog 於 242 天前認領，目前沒有進行中的 PR。 未關閉enhancement needs design website
難度 5/5 一週以上 新手友好度 25/100
aboutcode-org/www.aboutcode.org#141 · 已指派 1 人 ·
查看 aboutcode-org/www.aboutcode.org 的全部 Issue
相似的 Issue
-
難度 2/5 1-3 小時 新手友好度 82/100
維護者通常 1 天內回覆
-
check:failed logos:add
難度 2/5 1-3 小時 新手友好度 67/100
iptv-org/database#38874 · 1 則留言 ·
維護者通常 4 天內回覆
-
documentation
難度 2/5 1-3 小時 新手友好度 85/100
githubnext/gh-aw-workshop#5193 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 72/100
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 72/100