Skip to content

Fix Zenodo badge on landing page#598

Merged
brian-rose merged 10 commits intoProjectPythia:mainfrom
brian-rose:badge
Feb 19, 2026
Merged

Fix Zenodo badge on landing page#598
brian-rose merged 10 commits intoProjectPythia:mainfrom
brian-rose:badge

Conversation

@brian-rose
Copy link
Copy Markdown
Member

Following #592, this PR fixes the Zenodo badge that is displayed on the book landing page (https://foundations.projectpythia.org)

@review-notebook-app
Copy link
Copy Markdown

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@github-actions
Copy link
Copy Markdown

github-actions bot commented Feb 16, 2026

👋 Thanks for opening this PR! The Cookbook will be automatically built with GitHub Actions. To see the status of your deployment, click below.
🔍 Git commit SHA: c6661cc
✅ Deployment Preview URL: https://ProjectPythia.github.io/pythia-foundations/_preview/598

@brian-rose
Copy link
Copy Markdown
Member Author

The badges look awkward in their current position, centered on the page and with line gaps between them. We want them to be discreetly lined up horizontally under the title, like on a GitHub readme page.

There is some guidance in the MyST docs here for alignment of subfigures, which should help.

@brian-rose
Copy link
Copy Markdown
Member Author

Since nothing I tried successfully got the badges to appear on the landing page without looking weird, I changed course here.

The badges are gone. Instead I specified our Zenodo DOI (the "all versions" one) in myst.yml and just let MyST handle putting the DOI link on the landing page automatically.

@brian-rose
Copy link
Copy Markdown
Member Author

A couple side notes:

  • The book landing page still just credits "Project Pythia Community" as authors, but we have a full author list that we use for the Zenodo archive. We should let MyST display the actual author names (along with ORCIDs, etc) here on the landing page
  • We will need to update the "How to Cite" section to acknowledge the JOSE paper at some point
  • The author list for the repository and the JOSE paper should be harmonized. There are people who are credited in the JOSE paper who should also be listed as authors of Foundations itself.

@brian-rose brian-rose marked this pull request as ready for review February 18, 2026 21:43
@brian-rose brian-rose requested a review from a team as a code owner February 18, 2026 21:43
@brian-rose brian-rose requested review from dcamron, mgrover1 and r-ford and removed request for a team February 18, 2026 21:43
@brian-rose
Copy link
Copy Markdown
Member Author

This PR also closes #553 for Foundations, although a broader issue affecting how we template Cookbooks still needs to be solved there I think.

Copy link
Copy Markdown
Contributor

@kafitzgerald kafitzgerald left a comment

Choose a reason for hiding this comment

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

Bit of a bummer to lose the badges on the README, but I think this makes sense.

@brian-rose
Copy link
Copy Markdown
Member Author

So to be clear, the badges are still on the README that gets displayed on GitHub. This PR just affects the landing page of the rendered book.

Because of some differences in how the markdown is rendered by myst versus GitHub, keeping those two pages looking the same was difficult.

@kafitzgerald
Copy link
Copy Markdown
Contributor

So to be clear, the badges are still on the README that gets displayed on GitHub. This PR just affects the landing page of the rendered book.

Because of some differences in how the markdown is rendered by myst versus GitHub, keeping those two pages looking the same was difficult.

My mistake. For some reason I had assumed the landing page and README were the same here (perhaps it is in cookbooks).

Thanks for the clarification on that.

@brian-rose
Copy link
Copy Markdown
Member Author

My mistake. For some reason I had assumed the landing page and README were the same here (perhaps it is in cookbooks).

That is indeed how it works in the Cookbook repos. Foundations has a separate README that isn't included in the rendered book.

Recent versions of MyST seem to have changed how the badges are rendered, which is making lots of cookbook landing pages look a bit weird, e.g. here.

I'll open a separate issue elsewhere to track that.

@brian-rose brian-rose merged commit fafcf85 into ProjectPythia:main Feb 19, 2026
3 checks passed
@brian-rose brian-rose deleted the badge branch February 19, 2026 13:58
github-actions bot pushed a commit that referenced this pull request Feb 19, 2026
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