Generate an Obsidian Vault from the Notes in GHC Haskell
GHC Haskell has throughout its source code multiple Notes explaining bits of the compiler. It's sometimes quite useful to search through these notes only, and to see the connections between notes.
The Obsidian program to create and maintain knowledge bases.
ghc-obsidian
basically bridges the Haskell GHC Notes to an Obsidian Vault by extracting notes from the source code and creating a note in a new Obsidian vault for each GHC note.
One can then load the vault into Obsidian and search through and visualize the Notes of the GHC compiler.
Install the ghc-obsidian
executable with cabal by cloning this repository and running cabal install
inside.
Run ghc-obsidian
in the root of the ghc source code. This will create a folder called NotesVault
.
Choose "Open Vault" within the "File" tab in Obsidian, and select the NotesVault
folder in the ghc tree root.