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

[Feature request]: refactor flepimop_sample into flepimop/examples, provide example project auto copy-paste #368

Open
pearsonca opened this issue Oct 29, 2024 · 0 comments
Labels
documentation Relating to ReadMEs / gitbook / vignettes / etc. low priority Low priority. meta/workflow Relating to CI / issue templates / testing frameworks / etc.

Comments

@pearsonca
Copy link
Contributor

pearsonca commented Oct 29, 2024

Label

documentation, meta/workflow

Priority Label

low priority

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

In the gitbook, several of the guides suggest using a "flepimop_sample" repository, which appears to be approximately the same as the /examples folder.

This is duplicating code in multiple places, and increases work when documenting new library features with examples.

It complicates the future addition of CI to verify that examples run according to the associated instructions, because it would have to span repositories.

In the future, we intend the library to also include partial config files that specify typical models + a project skeleton builder. The examples should be driven by that.

Is your feature request related to a new application, scenario round, pathogen? Please describe.

No response

Describe the solution you'd like

Consolidate from flepimop_sample into examples. Update the current documentation to a copy operation from the examples folder (possibly also including a git init to turn that copy into a repo, if there are git actions with the example), rather than a clone operation from flepimop_sample.

@pearsonca pearsonca added documentation Relating to ReadMEs / gitbook / vignettes / etc. low priority Low priority. meta/workflow Relating to CI / issue templates / testing frameworks / etc. labels Oct 29, 2024
@pearsonca pearsonca added this to the Under 1Hr New Users! milestone Oct 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Relating to ReadMEs / gitbook / vignettes / etc. low priority Low priority. meta/workflow Relating to CI / issue templates / testing frameworks / etc.
Projects
None yet
Development

No branches or pull requests

1 participant