Skip to content

include partial+full guide for custom pacakges#122

Open
ShaivanBhagat wants to merge 2 commits intomainfrom
add-custom-packages
Open

include partial+full guide for custom pacakges#122
ShaivanBhagat wants to merge 2 commits intomainfrom
add-custom-packages

Conversation

@ShaivanBhagat
Copy link
Copy Markdown
Collaborator

includes:

  • partial (smaller) manual explaining custom packages and some quick info.
  • a longer detailed manual with more detailed how to use, where envs are stored, how to work with jupyter kernels, and install additional packages

I have not linked this to VRE Lab workspace manual (yet). If this looks good, then I will include the partial in the Vre lab manual

@jelletreep
Copy link
Copy Markdown
Member

Hi @ShaivanBhagat, Thanks so much for this contribution! I think it is very useful and complete, however also a bit on the long side. For the partial I provided a suggestion on how to shorten it. For the full manual I wasn't sure yet on what to remove. If you have ideas to shorten it, great! however, we could also keep it long for now and reduce later.

Since @dometto is author of this component, could you go over this and see if I missed some things in my review?

@dometto
Copy link
Copy Markdown
Member

dometto commented Apr 21, 2026

This looks great! Suggestions for shortening:

  • "Using Environments in Jupyter Notebooks" <-- could potentially be moved to a separate manual? Not sure!
  • The alternatives for python/conda in the various sections could be put in collapsible elements, so the manual doesn't appear as long for the enduser. This would also allow easily adding Julia at a later point.

Agree we can also merge as is and shorten later.

@ShaivanBhagat
Copy link
Copy Markdown
Collaborator Author

Dawa's suggestions make sense and will help shorten it. I will also see where can i shorten it without taking away much of the content. I can shorten the partials file to a good extent as well.

@ShaivanBhagat
Copy link
Copy Markdown
Collaborator Author

Hi @dometto @jelletreep, I have shortened the partial to some extent. For the full manual, i have used tabsets for conda/python-uv environments, and tried to shorten it as well. Let me know if it needs to be shortened further

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.

3 participants