Local developement docs are outdated

Open Beginner friendly
#2,197 1 comment 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

@nik-767 is already working on this.

Since Jul 16, 2026.

  • #2199 by @nik-767 — open

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
82/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
docker
Domain
documentation

Research direction

Open docs/installation.rst at the linked local-development section and inspect PR #2145 for the docker-based workflow it introduces. Compare that flow against the current local-development text and update the outdated virtualenv references accordingly. Then verify the docs page at the linked ReadTheDocs installation URL reflects the same steps. The issue is complete when that section documents a docker-based local setup and no longer instructs virtualenv usage.

Written by the indexing model from the issue text.

Description

It seems we have recently moved to a docker based local development instead of a virtualenv one with:

The documentation has not been updated and this is outdated:

Dominant language
Python
Stars
226
Forks
222
Avg merge
1d 5h
Merged PRs (30d)
32

Getting set up

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/scancode.io

All issues in aboutcode-org/scancode.io

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.