aboutcode-org / aboutcode-org/aboutcode-toolkit

Improve documentation for Attribution

Open
#507 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
100
Forks
49
PR merge metrics
No merged PRs in 30d

Description

Within the ABCTK documentation, we should make a distinction between the features and functions that operate on ABOUT files and those that do not require ABOUT files - namely Attribution. This means that we should organized the documentation at a high level under either Attribution or ABOUT files. The attrib and transform commands would be under Attribution and the rest under ABOUT files.

We also need a much more detailed explanation of the content of the transform yaml files - this could just be a copy of the help text from the --help--format function. We do not want to required someone to install ABCTK just to understand how the transform can work.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.