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

docs: regenerate gh readme #385

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: regenerate gh readme #385

wants to merge 2 commits into from

Conversation

machow
Copy link
Owner

@machow machow commented Dec 5, 2024

This PR addresses an issue flagged by @chendaniely -- the intro snippet produces errors.

Note that one important piece here is that the github readme is generated from the quartodoc homepage (currently https://machow.github.io/quartodoc/get-started/overview.html). But this hadn't been regenerated to reflect the latest there.

I don't love how verbose the intro snippet is now, but let's just get it working in this PR. I think there are some nice ways to streamline things down the road!

TODO: add a test of the intro snippet

@codecov-commenter
Copy link

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.78%. Comparing base (ee4fa3c) to head (7edf864).

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #385   +/-   ##
=======================================
  Coverage   88.78%   88.78%           
=======================================
  Files          37       37           
  Lines        3004     3004           
=======================================
  Hits         2667     2667           
  Misses        337      337           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants