Skip to content
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

Add Project IDX support #318

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Add Project IDX support #318

wants to merge 11 commits into from

Conversation

rodydavis
Copy link

Support for Project IDX:
https://idx.dev

TLDR: Opens the cookbook in IDX as a template with a full VM and filesystem.

Test the template here:

Try in IDX

@github-actions github-actions bot added the status:awaiting review PR awaiting review from a maintainer label Nov 8, 2024
@Giom-V Giom-V assigned Giom-V and unassigned Giom-V Nov 14, 2024
@Giom-V Giom-V self-requested a review November 14, 2024 08:25
Copy link
Collaborator

Choose a reason for hiding this comment

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

Would there be a way to move those files out of the main folder? Ideally I would prefer to have it as clean as possible and not risk a for a beginning user to run the requirements for nothing.


To run any notebook in [IDX](https://idx.dev) replace the TODO in `.idx/dev.nix` with your Gemini API key by:
- Selecting "Add Gemini API" in the "Project IDX" panel in the sidebar
- Or by visiting https://g.co/ai/idxGetGeminiKey
Copy link
Collaborator

Choose a reason for hiding this comment

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

I guess you want to track how many keys were created through IDX but I would prefer if we do not use different urls for the same website on the same page so I'd use https://aistudio.google.com/app/apikey

@@ -0,0 +1,35 @@
import os

def update_ipynb_files(directory):
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think you will also need to update all the internal links, otherwise the links in the "what's next" sections of each notebook will open the github instead of the corresponding notebook in IDX, breaking the learning path.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe that point will not be a problem as I'm trying to replace all the absolute links by relative ones.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status:awaiting review PR awaiting review from a maintainer
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants