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

Documentation for data processing pipeline #1

Open
annahaensch opened this issue Feb 22, 2022 · 0 comments
Open

Documentation for data processing pipeline #1

annahaensch opened this issue Feb 22, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@annahaensch
Copy link
Collaborator

Originally opened by @maminian on Dec. 16, 2021

Document individual steps in the data processing pipeline; how are pdf files converted to csv/json/other tabular format? I think it makes sense to make this happen at a general descriptive level at first, then fill in greater details later, if/when details of the processing change.

Not sure the specific way we should approach documentation, some options:

  • plain text file
  • Some markup language (github's markdown for instance)
  • Using one of the tools out there to create a fancy user guide/documentation website combo; you often see these with academic software packages. I can find an example later.
@annahaensch annahaensch added the documentation Improvements or additions to documentation label Feb 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant