DOCS: Create set of reference code project to be used across AboutCode tutorials

Open
#57 1 comment 0 reactions 0 assignees View on GitHub

@saurabh24thakur is already working on this.

Since Dec 25, 2025.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
30/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
c, cpp, javascript

Research direction

No files or tests are named. Start by reviewing the Docusaurus/Markdown tutorial structure and existing AboutCode tutorials, then define how three reference examples should represent frontend, backend, and embedded C/C++ users. Done means three agreed examples are created and incorporated into the tutorials, but the issue does not specify their content or acceptance criteria.

Written by the indexing model from the issue text.

Description

documentation

Setting up some of the AboutCode project can quite resource and knowledge intensive so to give potential users a better idea of what AboutCode project are capable of we propose to create a set of reference examples to be used within tutorials

Propose to create three reference code example that is relatable to a frontend, backend and embedded/C/C++ developers

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

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from aboutcode-org/www.aboutcode.org

All issues in aboutcode-org/www.aboutcode.org

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.