-
Notifications
You must be signed in to change notification settings - Fork 5.5k
Add author and notebook registry for cookbooks #237
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
Merged
Merged
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
4ed502f
feat: initialize cookbook registry and author management system
PedramNavid a3c3849
update registry
PedramNavid 295d9cd
refactor: simplify registry.yaml descriptions for clarity
PedramNavid 55c927b
feat: migrate registry from single category to multiple categories
PedramNavid 3adcaef
refactor: extract author verification logic to standalone script
PedramNavid 92760b6
refactor: rename verify_authors.py to verify_registry.py and expand v…
PedramNavid c26251d
feat: add JSON schema validation for registry and authors files
PedramNavid 6e9dbfc
image -> multimodal
PedramNavid File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| { | ||
| "$schema": "http://json-schema.org/draft-07/schema#", | ||
| "title": "Authors Schema", | ||
| "description": "Schema for authors.yml - maps GitHub usernames to author details", | ||
| "type": "object", | ||
| "patternProperties": { | ||
| "^[a-zA-Z0-9_-]+$": { | ||
| "type": "object", | ||
| "properties": { | ||
| "name": { | ||
| "type": "string", | ||
| "description": "Full display name of the author" | ||
| }, | ||
| "website": { | ||
| "type": "string", | ||
| "format": "uri", | ||
| "description": "Author's website URL (optional)" | ||
| }, | ||
| "avatar": { | ||
| "type": "string", | ||
| "format": "uri", | ||
| "description": "Avatar image URL (optional, defaults to https://github.com/username.png)" | ||
| } | ||
| }, | ||
| "required": ["name"], | ||
| "additionalProperties": false | ||
| } | ||
| }, | ||
| "additionalProperties": false | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| { | ||
| "$schema": "http://json-schema.org/draft-07/schema#", | ||
| "title": "Registry Schema", | ||
| "description": "Schema for registry.yaml - cookbook metadata", | ||
| "type": "array", | ||
| "items": { | ||
| "type": "object", | ||
| "properties": { | ||
| "title": { | ||
| "type": "string", | ||
| "description": "Title of the cookbook" | ||
| }, | ||
| "description": { | ||
| "type": "string", | ||
| "description": "Brief description of the cookbook" | ||
| }, | ||
| "path": { | ||
| "type": "string", | ||
| "description": "Path to the notebook file" | ||
| }, | ||
| "slug": { | ||
| "type": "string", | ||
| "pattern": "^[a-z0-9-]+$", | ||
| "description": "URL-friendly slug for the cookbook" | ||
| }, | ||
| "categories": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "string", | ||
| "enum": [ | ||
| "Agent Patterns", | ||
| "Claude Agent SDK", | ||
| "Evals", | ||
| "Fine-Tuning", | ||
| "Images", | ||
| "Integrations", | ||
| "Observability", | ||
| "RAG & Retrieval", | ||
| "Responses", | ||
| "Skills", | ||
| "Thinking", | ||
| "Tools" | ||
| ] | ||
| }, | ||
| "minItems": 1, | ||
| "description": "Categories of the cookbook" | ||
| }, | ||
| "github_url": { | ||
| "type": "string", | ||
| "format": "uri", | ||
| "description": "GitHub URL to the notebook" | ||
| }, | ||
| "authors": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "string", | ||
| "description": "GitHub username (must match keys in authors.yml)" | ||
| }, | ||
| "minItems": 1, | ||
| "description": "List of author GitHub usernames" | ||
| }, | ||
| "date": { | ||
| "type": "string", | ||
| "pattern": "^\\d{4}-\\d{2}-\\d{2}$", | ||
| "description": "Publication date in YYYY-MM-DD format" | ||
| }, | ||
| "tags": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "string" | ||
| }, | ||
| "description": "Tags for the cookbook" | ||
| }, | ||
| "difficulty": { | ||
| "type": "string", | ||
| "enum": ["beginner", "intermediate", "advanced", ""], | ||
| "description": "Difficulty level (optional)" | ||
| }, | ||
| "use_case": { | ||
| "type": "string", | ||
| "description": "Use case category (optional)" | ||
| }, | ||
| "thumbnail": { | ||
| "type": "string", | ||
| "description": "Thumbnail image URL (optional)" | ||
| }, | ||
| "archived": { | ||
| "type": "boolean", | ||
| "description": "Whether the cookbook is archived (optional, defaults to false)" | ||
| } | ||
| }, | ||
| "required": ["title", "path", "categories", "authors", "date"], | ||
| "additionalProperties": false | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@elie there are the categories I came up with, let me know if you think there's others we should add!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's call it Multimodal instead of Images so that we can future proof.
Do you imagine "Tools" being tool use specific? Or more like "Capabilities"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch, updated.
Tools was really just the tools feature.
All the 'capabilities' notebooks I have under
RAG & Retrievalcurrently, that seemed to be closer to what a user might search. I found it hard to think of anything that wouldn't fall under a 'capability' especially now that there's multiple selections possible.