Missing documentation for versioning

[armijnhemel]

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

• Inconsistency
• New Section Request
• General Improvement
• Typo/Mistakes
• Other

[AndrewJerryV]

Hi, I'm working on fixing this issue. I am adding a new "Output data format version history" section to the versioning docs page (docs/source/explanation/scancode-versioning.rst)

I have one question: The v32.3.0 CHANGELOG says the format version bump was from 3.2.0 to 4.0.0, but I can't find where 3.2.0 was explicitly introduced. Was it in v32.2.0 (with the is_direct, is_private, is_virtual additions)?

I want to make sure the version history is accurate before submitting my PR.