Publish a machine-readable index at notebooks.json - #203
Merged
Conversation
Alongside the HTML index, the generator now writes notebooks.json: per dandiset, each notebook's path with its GitHub, Colab, and docker links and the ready-to-run docker command (null where a path does not apply), plus site-level URLs and a schema version. It is a stable contract for other sites, in particular dandiset landing pages on dandiarchive.org, to show the notebooks that exist for a dataset without any per-dandiset metadata work. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Contributor
|
Preview for this PR has been removed (PR closed). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Alongside the HTML index, the generator now writes
notebooks.json, served from https://notebooks.dandiarchive.org/notebooks.json once deployed. Per dandiset it lists each notebook's repo path with its GitHub URL, Colab URL, image reference, and a ready-to-run docker command (null where a path does not apply), plus site-level URLs and aschema_versionso the shape can evolve additively.The purpose is discoverability from the archive itself: a dandiset landing page on dandiarchive.org can fetch this static file and, when its ID is present, show the notebooks that exist for the dataset with their run links, with no per-dandiset metadata work and no runtime cost to the archive. I will open a companion issue on dandi-archive proposing that panel.
Rendered locally: 34 dandisets, 63 notebooks; a sample entry is in the commit message thread of the generator.
🤖 Generated with Claude Code