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

Add page of causal video resources from PyMC community into the docs #379

Merged
merged 4 commits into from
Jun 27, 2024

Conversation

ParthJohri
Copy link
Contributor

@ParthJohri ParthJohri commented Jun 26, 2024

feat: Add causal videos from PyMC / PyMC Labs community Issue No: 374

closes #374

What type of PR:-

  • ✨ Enhancement
  • πŸ“ƒ Documentation

Description

  1. Added the causal_video_resources page markdown file for the PyMC Labs Videos, used iframe to add the videos.
  2. Tested if the UI is responsive or not in both light and dark mode.
  3. Updated the index.md for the knowledge base to include the page link for the causal_video_resources.

Screenshot & Screen recording

causal_videos_docs.mov

link-check


πŸ“š Documentation preview πŸ“š: https://causalpy--379.org.readthedocs.build/en/379/

Copy link
Collaborator

@drbenvincent drbenvincent left a comment

Choose a reason for hiding this comment

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

Great stuff. Thanks for this. Can I request a small change?

Remove the level 2 markdown header "PyMC Videos" and instead replace with Level 2 markdown headers with a short video title above each of the videos. Something like:

  • Combining Bayes and Graph-based Causal Inference
  • Bayesian Causal Modeling
  • Guide to Causal Inference with PyMC

oh, and I think we may we well also add in the video from the home page as well seeing as that was pretty much a release announcement for CausalPy.

Copy link

codecov bot commented Jun 27, 2024

Codecov Report

All modified and coverable lines are covered by tests βœ…

Project coverage is 85.60%. Comparing base (2ac74e5) to head (2154428).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #379   +/-   ##
=======================================
  Coverage   85.60%   85.60%           
=======================================
  Files          22       22           
  Lines        1716     1716           
=======================================
  Hits         1469     1469           
  Misses        247      247           

β˜” View full report in Codecov by Sentry.
πŸ“’ Have feedback on the report? Share it here.

@ParthJohri
Copy link
Contributor Author

@drbenvincent , I made the following changes, please let me know if any other change has to be made.

Changes

  • Removed level 2 pyVideos header.
  • Added level 2 headers for respective causal videos.
  • Added home page video of announcement for CausalPy in the causal video resources as well.

Screenshots

change1
change2
change3
change4

@drbenvincent
Copy link
Collaborator

Excellent. Very minor thing, but can we change What if Causal reasoning meets Bayesian Inference to What if? Causal reasoning meets Bayesian Inference. Then we are good to merge :)

@ParthJohri
Copy link
Contributor Author

@drbenvincent I have made the title change, let me know if any other change has to be made?

change5

@drbenvincent
Copy link
Collaborator

Thanks very much for your first contribution @ParthJohri!

If you have time, if relevant, I'd be interested to hear about any pain points in the process of contributing. For example, could the CONTRIBUTING doc be clearer etc, or did you run into any issues setting up the dev environment?

I'll slightly modify the PR title simply because that it what will appear in the auto generated release notes.

Thanks again!

@drbenvincent drbenvincent changed the title feat: Add causal videos from PyMC / PyMC Labs community Add page of causal video resources from PyMC community into the docs Jun 27, 2024
@drbenvincent drbenvincent added the documentation Improvements or additions to documentation label Jun 27, 2024
@drbenvincent drbenvincent self-requested a review June 27, 2024 20:07
@drbenvincent drbenvincent merged commit 0fb293c into pymc-labs:main Jun 27, 2024
8 checks passed
@ParthJohri
Copy link
Contributor Author

Thanks very much for your first contribution @ParthJohri!

If you have time, if relevant, I'd be interested to hear about any pain points in the process of contributing. For example, could the CONTRIBUTING doc be clearer etc, or did you run into any issues setting up the dev environment?

I'll slightly modify the PR title simply because that it what will appear in the auto generated release notes.

Thanks again!

No, the CONTRIBUTING doc was pretty descriptive, I did come across some issues, for example I was getting some errors with mamba so used conda for setting up the dev environment, and after it, I was able to complete the task without any problems.

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

Successfully merging this pull request may close these issues.

Add causal videos from PyMC / PyMC Labs community
2 participants