-
Notifications
You must be signed in to change notification settings - Fork 7
Small fixes to the README #135
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
base: main
Are you sure you want to change the base?
Conversation
niksirbi
commented
Nov 11, 2025
- Somewhat simplified installation instructions
- Fixed links to NPG's logo and social preview images
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #135 +/- ##
=======================================
Coverage 54.95% 54.95%
=======================================
Files 42 42
Lines 3683 3683
=======================================
Hits 2024 2024
Misses 1659 1659 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
The Sphinx build is breaking because fixing the image links for the README broke the paths for the website's homepage. That's because the current website simply includes the README.md file as is, which is doomed to fail. Image links, admonitions and many other elements will fail to properly render with that approach. Either we have to invest significant effort in building a proper docs website for NeuralPlayground (see #40), or we have to remove the current website elements (and related CI jobs). |
|
In a call with @rodrigcd today we discussed that we'll probably get rid of the current prototype Sphinx website, so we can ignore the failing Build Sphinx Docs action here. That actions workflow should be removed together with the docs folder. |
f548c85 to
feeb9bf
Compare
for more information, see https://pre-commit.ci
|
I've rebased this PR to |