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.

Sign up for GitHub

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

Jump to bottom

docs: add a basic "how to run study" doc #39

Merged
merged 1 commit into from
Jun 17, 2024
Merged

docs: add a basic "how to run study" doc #39

merged 1 commit into from
Jun 17, 2024

Conversation

mikix
Copy link
Contributor

@mikix mikix commented Jun 17, 2024 •
edited
Loading

Description

I ran through these instructions myself as a proof of concept - seems to work.

Checklist

  • Consider if documentation (like in docs/) needs to be updated
  • Consider if tests should be added
  • Run pylint if you're making changes beyond adding studies

dogversioning
dogversioning approved these changes Jun 17, 2024
View reviewed changes
Copy link
Contributor

@dogversioning dogversioning left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Food for thought - maybe chart-review could point over here as an example use case?

@mikix
Copy link
Contributor Author

mikix commented Jun 17, 2024

Food for thought - maybe chart-review could point over here as an example use case?

Yeah maybe - a "real world" uses section or something.

@mikix mikix merged commit ea07250 into main Jun 17, 2024
2 checks passed
@mikix mikix deleted the mikix/docs branch June 17, 2024 20:54
@mikix mikix mentioned this pull request Jun 17, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dogversioning dogversioning dogversioning approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mikix @dogversioning