CRAVEX-Docs: Improve documentation
@pombredanne is already working on this.
Since May 28, 2026.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- javascript, markdown, wordpress
- Domain
- content, documentation, web-dev
Research direction
Start by inventorying the existing Docusaurus/Markdown content in the www.aboutcode.org repository and the current WordPress and Read the Docs/Sphinx sites described in the issue. Define one small documentation increment with a specific getting-started outcome before changing anything; done should be a published guide or tutorial that can receive community feedback.
Written by the indexing model from the issue text.
Description
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.
- Dominant language
- JavaScript
- Stars
- 9
- Forks
- 18
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from aboutcode-org/www.aboutcode.org
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Add hover effects to adopter logos in the Community and Adopters sectionPossibly taken @riddheshkadu3637-ui claimed this 3 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Making all post button.Possibly taken @sarthaklole claimed this 90 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
aboutcode-org/www.aboutcode.org#117 · 3 comments ·
-
WWW: Reduce frequency of update-releasesMay be free again @johnmhoran claimed this 71 days ago, and no pull request is open. Openci-workflow
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
aboutcode-org/www.aboutcode.org#180 · 1 assignee ·
-
DOCS: Create new AboutCode stack diagram(s)May be free again @hixvikas claimed this 72 days ago, and no pull request is open. Opendocumentation
Difficulty 5/5 Over a week Newbie friendliness 35/100
aboutcode-org/www.aboutcode.org#166 · 1 comment ·
All issues in aboutcode-org/www.aboutcode.org
Similar issues
-
bug pydanty:is-working
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
pydantic/pydantic-ai#13939 ·
Maintainers usually reply within 1 day
-
self-host
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
funmusicplace/mirlo#2625 ·
Maintainers usually reply within 1 day
-
Bug Tests
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
JSPrismarine/JSPrismarine#3271 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 Half a day Newbie friendliness 85/100
sindresorhus/eslint-plugin-unicorn#4034 ·
Maintainers usually reply within 1 day
-
Content:WebExt needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day