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

List input/output file formats, compatible tools and possible workflows early in documentation #64

Open
ej159 opened this issue Jun 25, 2024 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@ej159
Copy link
Contributor

ej159 commented Jun 25, 2024

Is your feature request related to a problem? Please describe.

It would be really good to clearly show:

  • file formats for inputs to the tool(s)
  • file formats for output from the tool(s)
  • other tools that are compatible/interoperable.

Describe the solution you'd like

  • A list of file formats or, even better, a table on the first page of the documentation.
  • A flowchart of what the tool does at a high level

Describe alternatives you've considered

These things are documented but one has to dig through the docs which makes it hard to conceptualise all the great things that the tools can do for me.

@m-julian m-julian self-assigned this Jun 25, 2024
@m-julian m-julian added the enhancement New feature or request label Jun 25, 2024
@m-julian
Copy link
Contributor

Thanks, that would be a nice addition! I'll find some time to add a table with file formats along with some more exampes can run to get a feel of what the code can do.

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

No branches or pull requests

2 participants