-
Notifications
You must be signed in to change notification settings - Fork 5
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
Gather demo notebooks from older standalones #48
Labels
Comments
aimalz
added
documentation
Improvements or additions to documentation
good first issue
Good for newcomers
labels
Jun 30, 2023
4 tasks
This was referenced Nov 14, 2023
4 tasks
This was referenced Nov 29, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Some of the rail* repos created before the recent refactoring have single-estimator demos in nonuniformly named directories, but the recently made rail* repos had their demos moved to this repo. This issue is for gathering the single-estimator demos from the following places and sorting them into the demo directories under
examples
here:added_examples
docs/notebooks
examples
examples
src/rail/added_examples
To document this change, @alice-crafford has made the helpful suggestion to add explanatory text in each subdirectory of rail/examples describing what can be found in each of the demos so users asking "Where should I look to see how to do X?" can answer their own questions rather than asking a developer every time. All the rail/examples subdirectories except for estimation_examples actually have a starting point in a README.md, so this is mostly about making sure those all exist, are complete, and have sufficient detail for a user to determine which they need.
(I think it's fine for this issue to just get the descriptions into READMEs until #42 is resolved, but the next step would be to ensure this content gets rendered on ReadTheDocs, which may entail moving their contents to other .rst files within rail/docs/source.)
The text was updated successfully, but these errors were encountered: