aboutcode-org / aboutcode-org/scancode-toolkit

Improve presentation of available package parsers docs

Open
#3,789 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
2.6k
Forks
791
Avg merge
1d 12h
Merged PRs (30d)
5

Description

In https://scancode-toolkit.readthedocs.io/en/stable/reference/available_package_parsers.html the table is too wide and forces to scroll.
I think we need a different presentation entirely.
One idea:
- a top level table with one row each supported package type:
- package type, type description, link to a secondary section below
- then for each type, a list of repeated small tables, one for each parser/file type:

| Package type | pypi |
|-------------------|-------------|
| Description | lorem ipsum |
| Path Patterns | lorem ipsum |
| Package type | lorem ipsum |
| Datasource ID | lorem ipsum |
| Primary Language | lorem ipsum |
| Documentation URL | lorem ipsum |

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.