Here I will be describing the method to the vault.
For packages, there is certain information I always include. Some are:
- Metadata: In the frontmatter, I indicate that this page describes a package and I note if the packages is being maintained or not.
- Installation: If you get a new device or the HPC moves your home directory and messes up your conda environments (happened to me).
- Documentation Links: Packages get updated, it always good to revisit their documentation. For example, the developer might add a feature that you actually really need or didn’t know you need.
- Usage examples: I like to write done commands that I use but can’t seem to remember. It’s also a good place to copy and paste from.
- Errors: Some times a random error shows up and you don’t see it again for months. When the error shows up again, don’t waste your time googling how to fix it again.
A really useful part of this vault is how to organize and use research papers within the vault. This was implemented after coming across Christian B. B. Houmann’s tutorial (an important note is that I implemented the workflow before it was revamped in 2023). This requires the citation manager Zotero in conjunction with Better BibTeX (BBT).
First, install BBT then export your Zotero library.
After you set up Zotero, you will need to point to your exported Zotero library under the citation plugin settings: ![[citation plugin settings.png|500]]
Once you have done that, to add a paper to your vault, press the hotkey command + P and type in “Add paper” in the pop up window:
![[QuickAdd add paper.png|600]]
After selecting “QuickAdd: Add Paper”, start searching for the paper you want to add by typing a word from the paper’s title:
![[QuickAdd add paper search.png|600]] A new page with the paper’s citation key will be created in your vault under the folder Research/Papers.