DOCS: Improve AboutCode GitHub org README

Open
#45 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
github, markdown
Domain
documentation

Research direction

Open the linked AboutCode GitHub organization profile README and review how its current content introduces the projects. Add a brief explanation of the kinds of projects AboutCode provides and concise navigation to projects matching users’ needs. Done means the README offers a clearer onboarding path and links users to relevant projects.

Written by the indexing model from the issue text.

Description

documentation

Improve AboutCode GitHub org's README provide a better onboarding experience by:

  • Explain what kind of projects AboutCode provides
  • Navigate in smart and brief way users to projects that likely fulfills their needs.
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.