Improve documentation for Attribution

Open
#507 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python, yaml
Domain
cli, documentation

Research direction

Start by locating the ABCTK documentation and the help output for the transform command, especially the --help--format function mentioned in the issue. Reorganize the high-level documentation into Attribution and ABOUT files sections, placing attrib and transform under Attribution. Done means the transform YAML content is explained in the documentation without requiring an ABCTK installation.

Written by the indexing model from the issue text.

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.

Dominant language
Python
Stars
100
Forks
48
PR merge metrics
No merged PRs in 30d

Getting set up

  • Ships a Dockerfile or Docker Compose file
  • No pull request template
  • No contributing guide

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/aboutcode-toolkit

All issues in aboutcode-org/aboutcode-toolkit

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.