flake: document 'develop' package better

Signed-off-by: NotAShelf <raf@notashelf.dev>
Change-Id: Ida5b35a258dcc8ffa6fa6d653b76ddb36a6a6964

flake/develop.nix

@@ -1,15 +1,23 @@
 {lib, ...}: {
-  perSystem = {
+  perSystem = {pkgs, ...}: {
-    pkgs,
+    # The default dev shell provides packages required to interact with
-    config,
+    # the codebase as described by the contributing guidelines. It includes the
-    self',
+    # formatters required, and a few additional goodies for linting work.
-    ...
-  }: {
     devShells = {
-      default = self'.devShells.lsp;
+      default = pkgs.mkShellNoCC {
-      nvim-nix = pkgs.mkShellNoCC {packages = [config.packages.nix];};
+        packages = with pkgs; [
-      lsp = pkgs.mkShellNoCC {
+          # Nix tooling
-        packages = with pkgs; [nil statix deadnix alejandra npins];
+          nil # LSP
+          statix # static checker
+          deadnix # dead code finder
+
+          # So that we can interact with plugin sources
+          npins
+
+          # Formatters
+          alejandra
+          deno
+        ];
       };
     };
 
@@ -18,7 +26,11 @@
     # testing, but make sure to discard the changes before creating a pull
     # request.
     packages.dev = let
-      configuration = {};
+      configuration = {
+        # This is essentially the configuration that will be passed to the
+        # builder function. For example:
+        # vim.languages.nix.enable = true;
+      };
 
       customNeovim = lib.nvim.neovimConfiguration {
         inherit pkgs;