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

Update the README's How it works section with a new structure #29

Open
consideRatio opened this issue Jul 21, 2021 · 0 comments
Open

Update the README's How it works section with a new structure #29

consideRatio opened this issue Jul 21, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@consideRatio
Copy link
Member

Proposed change

To update our README's "How it works" section according to @yuvipanda's suggestion.

  1. What factors are taken into consideration for a notebook to be 'culled'. This would talk about CHP activity and when it is triggered, and same for the reports from the user server. This would be a high level description, and helps answer the question of 'What causes a notebook to be culled or not culled?'
  2. How these factors are calculated technically. This would point to code and add more details as you have done.

While doing this, I'd like to ask that it remains relevant still under the category "How it works" as I've used it as a reference from z2jh's docs.

@consideRatio consideRatio added the documentation Improvements or additions to documentation label Jul 21, 2021
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