Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation for Attribution #507

Open
mjherzog opened this issue Mar 21, 2022 · 0 comments
Open

Improve documentation for Attribution #507

mjherzog opened this issue Mar 21, 2022 · 0 comments

Comments

@mjherzog
Copy link
Member

mjherzog commented Mar 21, 2022

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant