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

Enhancement: User guide PDF needs data formatting #180

Open
2 tasks
Gero1999 opened this issue Jan 28, 2025 · 1 comment
Open
2 tasks

Enhancement: User guide PDF needs data formatting #180

Gero1999 opened this issue Jan 28, 2025 · 1 comment
Labels
enhancement New feature or request

Comments

@Gero1999
Copy link
Collaborator

Gero1999 commented Jan 28, 2025

Description

As @Shaakon35 suggested, even if it is temporary it would be highly beneficial to have the input dataset needed for the app so the user before starting the app can understand what they exactly need. Just a dataset defining the columns and formats.

We can also reuse it at some point when we deploy the app!

Definition of Done

The requirements for the feature to be complete:

  • Very short initial dataset in the guidelines showing the formats expected for the input of the app
  • In the README move it to Documentation section
@Gero1999 Gero1999 added the enhancement New feature or request label Jan 28, 2025
@Gero1999 Gero1999 added this to aNCA Jan 28, 2025
@Shaakon35 Shaakon35 moved this to Todo in aNCA Jan 28, 2025
@m-kolomanski
Copy link
Collaborator

I would suggest waiting with this task until after #183 is merged and then I would focus on migrating the PDF guide into a vignette / article within the scope of #75.

I could setup an initial article based on the PDF, so that then you could build on top of that, instead of maintaining a temporary PDF file.

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
Status: Todo
Development

No branches or pull requests

2 participants