aboutcode-org / aboutcode-org/scancode-toolkit

Missing documentation for versioning

Open
#4,868 1 comment 0 reactions 1 assignee Claimed by @AyanSinhaMahapatra View on GitHub
documentation
Dominant language
Python
Stars
2.6k
Forks
791
Avg merge
1d 12h
Merged PRs (30d)
5

Description

### Description

> A brief description of the Documentation Improvement or New Section request.

The file `src/scancode_config.py` says:

```
# See https://scancode-toolkit.readthedocs.io/en/latest/misc/versioning.html
# for more information on the data format version
```

but this link doesn't work. There is a scancode versioning page at:

https://scancode-toolkit.readthedocs.io/en/stable/explanation/scancode-versioning.html

but this doesn't mention anything about changes to the data format.

### Link to Documentation Page

> Where the confusion/inconsistency/incomplete documentation is.

### Select Category

- [X] Inconsistency
- [ ] New Section Request
- [ ] General Improvement
- [ ] Typo/Mistakes
- [ ] Other

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.