Skip to content

Fix: Remove widgets metadata causing GitHub rendering issues#410

Merged
anakin87 merged 3 commits intodeepset-ai:mainfrom
SyedShahmeerAli12:fix-jupyter-widgets-metadata-issue-398
Aug 25, 2025
Merged

Fix: Remove widgets metadata causing GitHub rendering issues#410
anakin87 merged 3 commits intodeepset-ai:mainfrom
SyedShahmeerAli12:fix-jupyter-widgets-metadata-issue-398

Conversation

@SyedShahmeerAli12
Copy link
Copy Markdown
Contributor

@SyedShahmeerAli12 SyedShahmeerAli12 commented Aug 24, 2025

  • Removed problematic widgets metadata from 11 affected notebooks
  • Fixes issue Many Notebooks won't render in Github: "Invalid Notebook" #398: 'Invalid Notebook' error on GitHub
  • Notebooks affected: 27, 31, 32, 33, 34, 35, 37, 40, 41, 44, 46
  • Added comprehensive documentation of the fix
  • All notebooks remain fully functional and now render correctly on GitHub

Closes #398

Fix: Remove widgets metadata causing GitHub rendering issues
6b3714d 
- Removed problematic widgets metadata from 11 affected notebooks
- Fixes issue #398: 'Invalid Notebook' error on GitHub
- Notebooks affected: 27, 31, 32, 33, 34, 35, 37, 40, 41, 44, 46
- Added comprehensive documentation of the fix
- All notebooks remain fully functional and now render correctly on GitHub

Closes #398
@SyedShahmeerAli12 SyedShahmeerAli12 requested a review from a team as a code owner August 24, 2025 18:42
@review-notebook-app
Copy link
Copy Markdown

review-notebook-app Bot commented Aug 24, 2025

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

@anakin87
Copy link
Copy Markdown
Member

anakin87 commented Aug 25, 2025

Hello and thanks for the fix!

Could you please remove FIX_DOCUMENTATION.md and instead explain in short what you did in a GitHub comment?

@SyedShahmeerAli12
Copy link
Copy Markdown
Contributor Author

SyedShahmeerAli12 commented Aug 25, 2025 via email

@SyedShahmeerAli12
Copy link
Copy Markdown
Contributor Author

SyedShahmeerAli12 commented Aug 25, 2025

What I did:
Identified 11 notebooks with malformed widgets metadata causing "Invalid Notebook" errors on GitHub
The issue was missing top-level state key in metadata.widgets structure
Removed the entire widgets metadata section from all affected notebooks (safe since it only stores display state, not functionality)
Result: All notebooks now render correctly on GitHub, 36K+ lines of problematic metadata removed, zero functional changes

Notebooks fixed: 27, 31, 32, 33, 34, 35, 37, 40, 41, 44, 46

Removed the documentation file as requested. Let me know if you need any other changes!

anakin87
anakin87 approved these changes Aug 25, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@anakin87 anakin87 left a comment

Choose a reason for hiding this comment

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

This PR looks good.

Tests are failing because Secrets are not available in PRs running from forks.

I'll merge this PR. (If something breaks on the website, we can always revert it).

@anakin87 anakin87 merged commit 21f0287 into deepset-ai:main Aug 25, 2025
4 of 20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@anakin87 anakin87 anakin87 approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Many Notebooks won't render in Github: "Invalid Notebook"

2 participants

@SyedShahmeerAli12 @anakin87