aboutcode-org / aboutcode-org/www.aboutcode.org
CRAVEX-Docs: Improve documentation
- 主要言語
- JavaScript
- スター
- 9
- フォーク
- 18
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
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.
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
評価
この issue はまだ評価されていません。