docs

emacs/feature/feature-base.el

@@ -18,7 +18,6 @@
 (require 'module-scratch)
 (require 'module-eyecandy)
 (require 'module-avy)
-(require 'module-snippets)
 (require 'module-browser)
 
 

emacs/feature/feature-better-minibuf.el

@@ -1,8 +1,9 @@
-;;; feature-better-minibuf.el -- knowledge management
+;;; feature-better-minibuf.el -- better minibuffers
 ;;;
 ;;; Commentary:
 ;;;
-;;; Loads modules related to knowledge management.
+;;; Emacs minibuffer kind of sucks by default.  Improves and extends
+;;; Emacs minibuffer functionality.
 ;;;
 ;;; Code:
 

emacs/feature/feature-completion.el

@@ -1,13 +1,13 @@
-;;; feature-completion.el -- knowledge management
+;;; feature-completion.el -- automatic completion
 ;;;
 ;;; Commentary:
 ;;;
-;;; Loads modules related to knowledge management.
+;;; Automatic completion modules for lazy people.
 ;;;
 ;;; Code:
 
 (require 'module-orderless)
-
+(require 'module-snippets)
 
 (provide 'feature-completion)
 

emacs/feature/feature-consult.el

@@ -1,8 +1,10 @@
-;;; feature-consult.el -- knowledge management
+;;; feature-consult.el -- consult
 ;;;
 ;;; Commentary:
 ;;;
-;;; Loads modules related to knowledge management.
+;;; Consult provides enhanced search and navigation functionality for
+;;; Emacs.  It is broad enough in scope, and has enough extensions, to
+;;; warrant its own feature.
 ;;;
 ;;; Code:
 

emacs/feature/feature-dev.el

@@ -1,8 +1,9 @@
-;;; feature-dev.el -- knowledge management
+;;; feature-dev.el -- coding stuff
 ;;;
 ;;; Commentary:
 ;;;
-;;; Loads modules related to knowledge management.
+;;; Enables support for development related packages, such as
+;;; programming language major modes.
 ;;;
 ;;; Code:
 

emacs/feature/feature-diagram.el

@@ -2,7 +2,7 @@
 ;;;
 ;;; Commentary:
 ;;;
-;;; Loads modules related to diagramming.
+;;; Diagramming in plain text!
 ;;;
 ;;; Code:
 

emacs/feature/feature-feeds.el

@@ -1,13 +1,12 @@
-;;; feature-feeds.el -- knowledge management
+;;; feature-feeds.el -- news feeds
 ;;;
 ;;; Commentary:
 ;;;
-;;; Loads modules related to knowledge management.
+;;; Read news feeds from Emacs, because browsing the web sucks.
 ;;;
 ;;; Code:
 
 (require 'module-rss)
 
 (provide 'feature-feeds)
-
 ;;; feature-feeds.el ends here.

emacs/feature/feature-project.el

@@ -1,8 +1,9 @@
-;;; feature-project.el -- knowledge management
+;;; feature-project.el -- projects
 ;;;
 ;;; Commentary:
 ;;;
-;;; Loads modules related to knowledge management.
+;;; Provides a definition of a "project" to Emacs, and facilities for
+;;; working with them.
 ;;;
 ;;; Code:
 

emacs/feature/feature-vcs.el

@@ -2,7 +2,7 @@
 ;;;
 ;;; Commentary:
 ;;;
-;;; Loads modules related to version control.
+;;; Provides version control integration.
 ;;;
 ;;; Code:
 

emacs/init.el

@@ -37,4 +37,5 @@
 
 (load-theme 'misterioso)
 
+(provide 'init)
 ;;; init.el ends here

emacs/lisp/org-ai

@@ -1 +0,0 @@
-Subproject commit 02a43259e357846372672b58ba9416093493b3fb

emacs/module/module-alioth.el

@@ -1,6 +1,7 @@
 ;;; module-alioth.el --- alioth automount -*- lexical-binding: t; -*-
 ;;;
 ;;; Commentary:
+;;;
 ;;; Automount alioth on demand.
 ;;;
 ;;; Code:

emacs/module/module-apitest.el

@@ -1,5 +1,9 @@
-;;; module-apitest.el --- Brief description -*- lexical-binding: t; -*-
-
+;;; module-apitest.el --- api testing shit -*- lexical-binding: t; -*-
+;;;
+;;; Commentary:
+;;;
+;;; Postman is bullshit.  Do your API testing in Emacs.
+;;;
 ;;; Code:
 
 (require 'module-pkg)

emacs/module/module-async.el

@@ -1,7 +1,9 @@
 ;;; module-async.el --- async functionality -*- lexical-binding: t; -*-
-
+;;;
 ;;; Commentary:
-
+;;;
+;;; Enable async support in Emacs.
+;;;
 ;;; Code:
 
 (require 'module-pkg)

emacs/module/module-avy.el

@@ -1,7 +1,8 @@
-;;; module-avy.el --- package management wrapper -*- lexical-binding: t; -*-
+;;; module-avy.el --- quick jump -*- lexical-binding: t; -*-
 ;;;
 ;;; Commentary:
-;;; Provides package management wrappers.
+;;;
+;;; Adds quick-jump functionality to Emacs.
 ;;;
 ;;; Code:
 

emacs/module/module-browser.el

@@ -1,6 +1,10 @@
-;;; module-browser.el --- Brief description -*- lexical-binding: t; -*-
+;;; module-browser.el --- open webpages -*- lexical-binding: t; -*-
+;;;
 ;;; Commentary:
-
+;;;
+;;; Modern web browsers suck.  Open a webpage from within Emacs, and
+;;; allow opening with a sucky browser if you really have to.
+;;;
 ;;; Code:
 
 (require 'eww)

emacs/module/module-consult-projectile.el

@@ -1,6 +1,8 @@
 ;;;	module-consult-projectile.el --- consult/projectile integration
+;;;
 ;;; Commentary:
-;;; Integrate consult and projectile.
+;;;
+;;; Integrate consult with projectile.
 ;;;
 ;;; Code:
 

emacs/module/module-consult.el

@@ -1,5 +1,7 @@
 ;;; module-consult.el --- setup consult for emacs
+;;;
 ;;; Commentary:
+;;;
 ;;; Setup consult for Emacs.
 ;;;
 ;;; Code:

emacs/module/module-ctags.el

@@ -1,6 +1,9 @@
-;;; module-ctags.el --- Brief description -*- lexical-binding: t; -*-
+;;; module-ctags.el --- ctags functions -*- lexical-binding: t; -*-
+;;;
 ;;; Commentary:
-
+;;;
+;;; Generate ctags from inside Emacs.  Nifty!
+;;;
 ;;; Code:
 
 

emacs/module/module-denote-index.el

@@ -1,8 +1,9 @@
 ;;; module-denote-index.el -- index and metadata for denote notes
 ;;;
 ;;; Commentary:
-;;; Provides a mechanism for maintaining an index of
-;;; denote notes with useful metadata to facilitate search.
+;;;
+;;; Provides a mechanism for maintaining an index of denote notes with
+;;; useful metadata to facilitate search.
 ;;;
 ;;; Code:
 

emacs/module/module-denote-multidir.el

@@ -1,6 +1,7 @@
 ;;; module-denote-multidir.el --- denote with multi-dir support
 ;;;
 ;;; Commentary:
+;;;
 ;;; Extend denote with support for multiple notes directories.
 ;;;
 ;;; Code:

emacs/module/module-denote.el

@@ -1,7 +1,8 @@
-;;; module-denote.el --- note taking
+;;; module-denote.el --- sane note taking
 ;;;
 ;;; Commentary:
-;;; Configure denote for note taking purposes.
+;;;
+;;; Capturing and managing notes for sane people.
 ;;;
 ;;; Code:
 

emacs/module/module-detached.el

@@ -1,5 +1,7 @@
 ;;; module-detached.el --- dtach for Emacs
+;;;
 ;;; Commentary:
+;;;
 ;;; Setup dtach and Emacs integration.
 ;;;
 ;;; Code:

emacs/module/module-dired.el

@@ -1,6 +1,8 @@
 ;;; module-dired.el --- dired stuff
+;;;
 ;;; Commentary:
-;;; Configure Dired stuff.
+;;;
+;;; Configure settings and extensions for Dired.
 ;;;
 ;;; Code:
 

emacs/module/module-embark.el

@@ -1,6 +1,10 @@
-;;; module-embark.el --- Brief description -*- lexical-binding: t; -*-
+;;; module-embark.el --- context-sensitive actions -*- lexical-binding: t; -*-
+;;;
 ;;; Commentary:
-
+;;;
+;;; Provide context-sensitive actions on current target, including
+;;; minibuffer targets.
+;;;
 ;;; Code:
 
 

emacs/module/module-eshell.el

@@ -1,6 +1,7 @@
 ;;; module-eshell.el --- eshell enhancements.
 ;;; Commentary:
-;;; Configure eshell enhancements.
+;;;
+;;; Make eshell a little more usable.
 ;;;
 ;;; Code:
 

emacs/module/module-eyecandy.el

@@ -1,6 +1,9 @@
-;;; module-eyecandy.el --- Brief description -*- lexical-binding: t; -*-
+;;; module-eyecandy.el --- make emacs shiny -*- lexical-binding: t; -*-
+;;;
 ;;; Commentary:
-
+;;;
+;;; Add some eye candy to Emacs.
+;;;
 ;;; Code:
 
 (require 'module-pkg)

emacs/module/module-golang-playground.el

@@ -1,6 +1,9 @@
-;;; module-golang-playground.el --- Brief description -*- lexical-binding: t; -*-
+;;; module-golang-playground.el --- go experimentation sandbox -*- lexical-binding: t; -*-
+;;;
 ;;; Commentary:
-
+;;;
+;;; An experimentation sandbox for go programming.
+;;;
 ;;; Code:
 
 (require 'module-pkg)

emacs/module/module-golang.el

@@ -1,6 +1,9 @@
-;;; module-golang.el --- Brief description -*- lexical-binding: t; -*-
+;;; module-golang.el --- support golang -*- lexical-binding: t; -*-
+;;;
 ;;; Commentary:
-
+;;;
+;;; Adds support for golang to Emacs.
+;;;
 ;;; Code:
 
 (require 'module-pkg)

emacs/module/module-graphviz.el

@@ -1,6 +1,9 @@
-;;; module-graphviz.el --- Brief description -*- lexical-binding: t; -*-
+;;; module-graphviz.el --- diagrams for old people -*- lexical-binding: t; -*-
+;;;
 ;;; Commentary:
-
+;;;
+;;; Plain text diagramming software built before I was born.
+;;;
 ;;; Code:
 
 (require 'module-pkg)

emacs/module/module-json.el

@@ -1,6 +1,9 @@
-;;; module-json.el --- Brief description -*- lexical-binding: t; -*-
+;;; module-json.el --- JS based data serialization format -*- lexical-binding: t; -*-
+;;;
 ;;; Commentary:
-
+;;;
+;;; Add support for working with JSON data to Emacs.
+;;;
 ;;; Code:
 
 (require 'module-pkg)

emacs/module/module-kotlin.el

@@ -1,6 +1,10 @@
-;;; module-kotlin.el --- Brief description -*- lexical-binding: t; -*-
+;;; module-kotlin.el --- java for the less insane -*- lexical-binding: t; -*-
+;;;
 ;;; Commentary:
-
+;;;
+;;; A more tolerable programming language that compiles to JVM byte
+;;; code. Add Kotlin support to Emacs.
+;;;
 ;;; Code:
 
 (require 'module-pkg)

emacs/module/module-llm.el

@@ -25,7 +25,11 @@
   (ellama-setup-keymap))
 
 
-(pkg/require 'org-ai)
+;;(pkg/require 'org-ai)
+(straight-use-package
+ '(org-ai :type git :host github :repo "lneely/org-ai"))
+
+(require 'org-ai)
 (add-hook 'org-mode-hook #'org-ai-mode)
 
 (provide 'module-llm)

emacs/module/module-lmtf.el

@@ -1,6 +1,9 @@
-;;; module-lmtf.el --- Brief description -*- lexical-binding: t; -*-
+;;; module-lmtf.el --- lispy mctestface -*- lexical-binding: t; -*-
+;;;
 ;;; Commentary:
-
+;;;
+;;; Make testing your shitty elisp a little easier.
+;;;
 ;;; Code:
 
 

emacs/module/module-magit.el

@@ -1,5 +1,7 @@
 ;;; module-magit.el --- git integration
+;;;
 ;;; Commentary:
+;;;
 ;;; Setup git integration with Emacs.
 ;;;
 ;;; Code:

emacs/module/module-multi-cursor.el

@@ -1,6 +1,8 @@
 ;;; module-multi-cursor.el --- multiple cursors
 ;;; Commentary:
-;;; Multiple cursor support for Emacs.
+;;;
+;;; Multiple cursor support for Emacs.  Everyone else is doing it,
+;;; right?
 ;;;
 ;;; Code:
 

emacs/module/module-orderless.el

@@ -1,6 +1,9 @@
-;;; module-orderless.el --- fuzzy search
+;;; module-orderless.el --- efficient minibuffer completion
+;;;
 ;;; Commentary:
-;;; Setup fuzzy search for Emacs.
+;;;
+;;; Provides minibuffer completion for Emacs with fuzzy search
+;;; capabilities.
 ;;;
 ;;; Code:
 

emacs/module/module-org-denote.el

@@ -1,6 +1,8 @@
 ;;; module-org-denote.el --- denote extensions for org-mode
+;;;
 ;;; Commentary:
-;;; Setup org-mode denote extensions.
+;;;
+;;; Add denote-specific extensions to org-mode.
 ;;;
 ;;; Code:
 

emacs/module/module-org.el

@@ -1,6 +1,8 @@
 ;;; module-org.el --- org-mode
+;;;
 ;;; Commentary:
-;;; Setup org-mode for Emacs.
+;;;
+;;; Setup org-mode and extensions for Emacs.
 ;;;
 ;;; Code:
 

emacs/module/module-plantuml.el

@@ -1,6 +1,9 @@
-;;; module-plantuml.el --- Brief description -*- lexical-binding: t; -*-
+;;; module-plantuml.el --- diagramming for less old people -*- lexical-binding: t; -*-
+;;;
 ;;; Commentary:
-
+;;;
+;;; Build UML diagrams in plain text, so nobody can read them.
+;;;
 ;;; Code:
 
 (require 'module-pkg)

emacs/module/module-projectile.el

@@ -1,6 +1,8 @@
 ;;; module-projectile.el --- project management
+;;;
 ;;; Commentary:
-;;; Project management for Emacs nerds.
+;;;
+;;; The de facto standard for Emacs projects.
 ;;;
 ;;; Code:
 

emacs/module/module-protobuf.el

@@ -1,6 +1,9 @@
-;;; module-protobuf.el --- Brief description -*- lexical-binding: t; -*-
+;;; module-protobuf.el --- some google messaging shit -*- lexical-binding: t; -*-
+;;;
 ;;; Commentary:
-
+;;;
+;;; Add support for working with Google protobuf message definitions.
+;;;
 ;;; Code:
 
 (require 'module-pkg)

emacs/module/module-python.el

@@ -1,6 +1,9 @@
-;;; module-python.el --- Brief description -*- lexical-binding: t; -*-
+;;; module-python.el --- code that eats itself -*- lexical-binding: t; -*-
+;;;
 ;;; Commentary:
-
+;;;
+;;; Add python language support to Emacs.
+;;;
 ;;; Code:
 
 (require 'module-pkg)

emacs/module/module-rego.el

@@ -1,6 +1,9 @@
-;;; module-browser.el --- Brief description -*- lexical-binding: t; -*-
+;;; module-rego.el --- some policy language we use at work -*- lexical-binding: t; -*-
+;;;
 ;;; Commentary:
-
+;;;
+;;; Adds support for rego, a policy definition language, to Emacs.
+;;;
 ;;; Code:
 
 (require 'module-pkg)

emacs/module/module-rss.el

@@ -1,12 +1,13 @@
 ;;; module-orderless.el --- rss feeds in emacs
+;;;
 ;;; Commentary:
+;;;
 ;;; Read RSS feeds in Emacs, stop browsing the web.
 ;;;
 ;;; Code:
-(require 'module-pkg)
 
+(require 'module-pkg)
 (pkg/require 'elfeed)
 
 (provide 'module-rss)
-
 ;;; module-rss.el ends here.

emacs/module/module-scratch.el

@@ -1,5 +1,7 @@
 ;;; module-scratch.el --- scratch buffer enhancements
+;;;
 ;;; Commentary:
+;;;
 ;;; Scratch buffer enhancements for Emacs.
 ;;;
 ;;; Code:
@@ -8,6 +10,9 @@
 (pkg/require 'scratch)
 (pkg/require 'persistent-scratch)
 
+(defvar persistent-scratch-directory "~/.local/state/emacs/"
+	"The place to save persistent scratch buffers.")
+
 (defun my-set-scratch-mode ()
 	"Set default scratch mode."
   (funcall 'text-mode))

emacs/module/module-snippets.el

@@ -1,6 +1,10 @@
-;;; module-snippets.el --- Brief description -*- lexical-binding: t; -*-
+;;; module-snippets.el --- text snippets -*- lexical-binding: t; -*-
+;;;
 ;;; Commentary:
-
+;;;
+;;; Sometimes it's just too much effort to type the same shit over and
+;;; over again.
+;;;
 ;;; Code:
 
 

emacs/module/module-syntax.el

@@ -1,14 +1,18 @@
-;;; module-syntax.el --- syntax related stuff
+;;; module-syntax.el --- syntax checking and highlights
 ;;; Commentary:
-;;; Configure syntax-related settings.
+;;;
+;;; Add syntax checking and special purpose highlights for
+;;; programming.  Let Emacs compile that shit code of yours into
+;;; submission for you.
 ;;;
 ;;; Code:
 
 (require 'module-pkg)
 
 (pkg/require 'fic-mode)
-(pkg/require 'flycheck)
+(add-hook 'prog-mode-hook 'fic-mode)
 
+(pkg/require 'flycheck)
 (global-flycheck-mode)
 (setq flycheck-emacs-lisp-load-path 'inherit)
 

emacs/module/module-vertico.el

@@ -1,6 +1,7 @@
-;;; module-vertico.el --- better minibuffer
+;;; module-vertico.el --- vertical completion
 ;;; Commentary:
-;;; Better minibuffer for Emacs.
+;;;
+;;; Vertical completion UI for Emacs minibuffer.
 ;;;
 ;;; Code:
 

emacs/module/module-web.el

@@ -1,6 +1,10 @@
-;;; module-web.el --- Brief description -*- lexical-binding: t; -*-
+;;; module-web.el --- a veritable fucking mess -*- lexical-binding: t; -*-
+;;;
 ;;; Commentary:
-
+;;;
+;;; Add packages to Emacs to facilitate the absolute mess that is
+;;; modern web programming.
+;;;
 ;;; Code:
 
 (require 'module-pkg)

emacs/module/module-which-key.el

@@ -1,6 +1,10 @@
-;;; module-which-key.el --- Brief description -*- lexical-binding: t; -*-
+;;; module-which-key.el --- which-key -*- lexical-binding: t; -*-
+;;;
 ;;; Commentary:
-
+;;;
+;;; Help remember which key to press in the current key chord
+;;; "context," because memorization is overrated.
+;;;
 ;;; Code:
 
 (require 'module-pkg)

emacs/module/module-yaml.el

@@ -1,6 +1,9 @@
-;;; module-yaml.el --- Brief description -*- lexical-binding: t; -*-
+;;; module-yaml.el --- because we needed another fucking data format -*- lexical-binding: t; -*-
+;;;
 ;;; Commentary:
-
+;;;
+;;; Adds support for working with YAML files to Emacs.
+;;;
 ;;; Code:
 
 (require 'module-pkg)