From 5600947e3c07ecc4cba99eb2e97d9f902d41fd33 Mon Sep 17 00:00:00 2001
From: Craig Jennings <c@cjennings.net>
Date: Sun, 28 Jun 2026 03:39:46 -0400
Subject: docs: condense module commentaries to the terse header contract

22 module headers carried long user-manual commentaries (quick-starts, keybinding matrices, setup walkthroughs) that belong in user docs, not source. Each now states the purpose, load contract, and entry points tersely. ai-term also drops its stale F9 keybinding references (the scheme is C-; a plus M-SPC now) and a header line claiming a vertical-split that's really host-aware.
---
 archive/gptel/custom/gptel-prompts.el       | 54 +++--------------------------
 archive/gptel/gptel-tools/read_text_file.el |  4 +++
 2 files changed, 8 insertions(+), 50 deletions(-)

(limited to 'archive/gptel')

diff --git a/archive/gptel/custom/gptel-prompts.el b/archive/gptel/custom/gptel-prompts.el
index a2b266f27..28197ceba 100644
--- a/archive/gptel/custom/gptel-prompts.el
+++ b/archive/gptel/custom/gptel-prompts.el
@@ -29,58 +29,12 @@
 ;; Boston, MA 02111-1307, USA.
 
 ;;; Commentary:
-
-;; This package provides enhanced prompt management capabilities for GPTel,
-;; allowing you to organize and dynamically load AI prompts from external
-;; files rather than hardcoding them in your Emacs configuration.
-
-;; Key Features:
-;;
-;; * Multi-format prompt support: Load prompts from .txt, .md, .org, .json,
-;;   .eld (Emacs Lisp data), .el (Emacs Lisp functions), and .poet/.jinja
-;;   (Prompt Poet/Jinja2 templates)
-;;
-;; * Template interpolation: Use Jinja2-style {{variable}} syntax with
-;;   customizable variables and dynamic functions
-;;
-;; * File watching: Automatically reload prompts when files change
-;;
-;; * Project-aware prompts: Automatically load project-specific conventions
-;;   from CONVENTIONS.md or CLAUDE.md files
 ;;
-;; * Conversation format support: Handle multi-turn conversations with
-;;   system/user/assistant roles
-
-;; Setup:
-;;
-;;   (use-package gptel-prompts
-;;     :after (gptel)
-;;     :custom
-;;     (gptel-prompts-directory "~/my-prompts")
-;;     :config
-;;     (gptel-prompts-update)
-;;     ;; Optional: auto-reload on file changes
-;;     (gptel-prompts-add-update-watchers))
-
-;; File Formats:
-;;
-;; * Plain text (.txt, .md, .org): Used as-is for system prompts
-;; * JSON (.json): Array of {role: "system/user/assistant", content: "..."}
-;; * Emacs Lisp data (.eld): List format for conversations
-;; * Emacs Lisp code (.el): Lambda functions for dynamic prompts
-;; * Prompt Poet (.poet, .j2, .jinja, .jinja2): YAML + Jinja2 templates
-
-;; Template Variables:
-;;
-;; Use {{variable_name}} in your prompts. Variables can be defined in
-;; `gptel-prompts-template-variables' or generated dynamically by functions
-;; in `gptel-prompts-template-functions'.
-
-;; Project Integration:
+;; Adds file-backed GPTel directives. Prompt files can be plain text, structured
+;; conversations, Elisp data/functions, or Prompt Poet/Jinja templates.
 ;;
-;; Add `gptel-prompts-project-conventions' to `gptel-directives' to
-;; automatically load project-specific prompts from CONVENTIONS.md or
-;; CLAUDE.md files in your project root.
+;; The library can reload prompt files, interpolate configured template
+;; variables, and expose project-convention prompts from project roots.
 
 ;;; Code:
 
diff --git a/archive/gptel/gptel-tools/read_text_file.el b/archive/gptel/gptel-tools/read_text_file.el
index f35c94941..06a01db12 100644
--- a/archive/gptel/gptel-tools/read_text_file.el
+++ b/archive/gptel/gptel-tools/read_text_file.el
@@ -19,6 +19,10 @@
 ;; GNU General Public License for more details.
 
 ;;; Commentary:
+;;
+;; GPTel tool for safely reading text files under the user's home directory.
+;; It validates the resolved path, rejects directories and unreadable files,
+;; guards large files, and returns metadata alongside content.
 
 ;;; Code:
 
-- 
cgit v1.2.3