generated

Signed-off-by: Psionik K <73710933+psionic-k@users.noreply.github.com>
positron-solutions · Oct 24, 2023 · 7d2275f · 7d2275f
1 parent 77e964a
commit 7d2275f
Show file tree

Hide file tree

Showing 3 changed files with 79 additions and 79 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -5,36 +5,36 @@ Development process & infrastructure guide.
 
 # Table of Contents
 
--   [Submitting Pull Requests](#orgd4b2111)
--   [Development](#org6f22716)
-    -   [Running tests](#org39f87e2)
-    -   [Lint and byte-compile code](#orgdb6a70c)
-    -   [Loading and re-loading your package](#org2288378)
-    -   [Re-generating Documentation](#orgb891c6a)
--   [License](#orgb46cd92)
--   [Developer Certificate of Origin (DCO)](#orge70b7bb)
-    -   [Sign-off](#orgc3f586e)
-    -   [GPG signature](#org6b02174)
-    -   [User setup for submitting changes](#orgc65857c)
-    -   [Maintaining versions](#orgcaf43a4)
-
-
-<a id="orgd4b2111"></a>
+-   [Submitting Pull Requests](#orgb429362)
+-   [Development](#org65192b8)
+    -   [Running tests](#org8a3ddf5)
+    -   [Lint and byte-compile code](#org599b569)
+    -   [Loading and re-loading your package](#org9cf8d98)
+    -   [Re-generating Documentation](#org791ecf1)
+-   [License](#org4e7d017)
+-   [Developer Certificate of Origin (DCO)](#orgf6a4cbd)
+    -   [Sign-off](#orgf2ce616)
+    -   [GPG signature](#org6ba1a3a)
+    -   [User setup for submitting changes](#org10cbd6d)
+    -   [Maintaining versions](#org56b075d)
+
+
+<a id="orgb429362"></a>
 
 # Submitting Pull Requests
 
 Be sure to abide by instructions in [the pull request template](../.github/pull_request_template.md).
 
 
-<a id="org6f22716"></a>
+<a id="org65192b8"></a>
 
 # Development
 
 This repository was created with [elisp-repo-kit](https://github.com/positron-solutions/elisp-repo-kit/).  You can use it to streamline
 development workflows.
 
 
-<a id="org39f87e2"></a>
+<a id="org8a3ddf5"></a>
 
 ## Running tests
 
@@ -62,7 +62,7 @@ have.  **You do not need Nix to run tests pretty close to what CI does.** CI
 will use Nix to obtain Emacs & dependencies.
 
 
-<a id="orgdb6a70c"></a>
+<a id="org599b569"></a>
 
 ## Lint and byte-compile code
 
@@ -86,7 +86,7 @@ You can run the lints manually almost the same as running tests.
     emacs --script .github/run-shim.el -- lint-tests
 
 
-<a id="org2288378"></a>
+<a id="org9cf8d98"></a>
 
 ## Loading and re-loading your package
 
@@ -109,7 +109,7 @@ directly, call `emacs-lisp-byte-compile-and-load` or
 `emacs-lisp-native-compile-and-load`.
 
 
-<a id="orgb891c6a"></a>
+<a id="org791ecf1"></a>
 
 ## Re-generating Documentation
 
@@ -124,22 +124,22 @@ To manually export, use the appropriate org mode command:
 -   `org-texinfo-export-to-info`
 
 You can view the manual with prefix argument, `info-display-manual`, and
-manually type the path to the `.info` file.  Honestly, just use
+manually type the path to the `manual.info`.  Honestly, just use
 `elisp-repo-kit`.  This stuff is tedious.
 
 **NOTE** changes to the `manual.org` requires re-generation of other documents
  because they use `#+include:` directives.
 
 
-<a id="orgb46cd92"></a>
+<a id="org4e7d017"></a>
 
 # License
 
 This package is distributed under the terms of the [included license](./COPYING).  The CI
 configuration, documentation, and scripts are MIT licensed.
 
 
-<a id="orge70b7bb"></a>
+<a id="orgf6a4cbd"></a>
 
 # Developer Certificate of Origin (DCO)
 
@@ -152,7 +152,7 @@ A [copy of the DCO](./DCO) is distributed with this project.  Read its text to
 understand the significance of configuring for sign-off.
 
 
-<a id="orgc3f586e"></a>
+<a id="orgf2ce616"></a>
 
 ## Sign-off
 
@@ -163,7 +163,7 @@ following:
     Signed-off-by: Random J Developer <random@developer.example.org>
 
 
-<a id="org6b02174"></a>
+<a id="org6ba1a3a"></a>
 
 ## GPG signature
 
@@ -174,7 +174,7 @@ participating in.  Corroborating user's signature accross a history of works
 strengthens that user's attestation provided by DCO sign-off.
 
 
-<a id="orgc65857c"></a>
+<a id="org10cbd6d"></a>
 
 ## User setup for submitting changes
 
@@ -249,7 +249,7 @@ equivalent:
     git rebase -i
 
 
-<a id="orgcaf43a4"></a>
+<a id="org56b075d"></a>
 
 ## Maintaining versions
 

diff --git a/README.md b/README.md
@@ -63,27 +63,27 @@ your secrets for Cachix. Read the CI customization section.
 
 # Table of Contents
 
--   [Creating Packages](#orgbf14bf1)
--   [Using ERK for development](#org98720bd)
-    -   [Find Files](#orgf73e424)
--   [File contents and structure](#org8d1783d)
--   [Finish setting up your new GitHub repo](#org9cd1ddb)
-    -   [Optional Steps](#org833c99e)
--   [Customizing CI](#orgaa9298a)
--   [Licensing, Developer Certificate of Origin](#org3be8afd)
--   [Publishing to MELPA](#org09c7298)
-    -   [Creating the recipe](#org7388169)
-    -   [Testing package build](#org629febf)
-    -   [Testing stable package build](#orgb99d9c6)
-    -   [MELPA Lints](#orgfaacc4b)
--   [Maintaining versions](#org8ed3d8a)
--   [Package scope and relation to other work](#org401c164)
-    -   [Dependency Management](#orge880f34)
-    -   [Discovering and Running Tests & Lints](#org5248f8c)
-    -   [Comparisons](#org6350b87)
--   [Contributing](#org9a4b34c)
--   [Footnote on FSF and Emacs Core Licensing](#org4703ea1)
--   [Shout-outs](#org2ad2eb5)
+-   [Creating Packages](#orgea06217)
+-   [Using ERK for development](#orgda302a2)
+    -   [Find Files](#org9122b13)
+-   [File contents and structure](#org18ffd0b)
+-   [Finish setting up your new GitHub repo](#org988dca6)
+    -   [Optional Steps](#orgc464d5d)
+-   [Customizing CI](#org33dd9da)
+-   [Licensing, Developer Certificate of Origin](#orgcf113c3)
+-   [Publishing to MELPA](#org9c83480)
+    -   [Creating the recipe](#org019b7ce)
+    -   [Testing package build](#org06993c8)
+    -   [Testing stable package build](#orgef9b1ab)
+    -   [MELPA Lints](#org250bb5a)
+-   [Maintaining versions](#org375ed39)
+-   [Package scope and relation to other work](#org3eb6510)
+    -   [Dependency Management](#orgdc0473a)
+    -   [Discovering and Running Tests & Lints](#org6ea37ef)
+    -   [Comparisons](#org44a2f6b)
+-   [Contributing](#orgb0d9068)
+-   [Footnote on FSF and Emacs Core Licensing](#org03e68cf)
+-   [Shout-outs](#org63f3161)
 
 
 # Creating Packages
@@ -102,7 +102,7 @@ ask you for:
 
 `erk-new` also calls `erk-rename-relicense` to rename all of the files, string
 replace names, and re-license to GPL3.  It also changes the author and resets
-the git history.  Now just follow the steps in [finish setting up](#org9cd1ddb) Have fun!
+the git history.  Now just follow the steps in [finish setting up](#org988dca6) Have fun!
 
 
 # Using ERK for development
@@ -140,9 +140,9 @@ choices:
 -   ci-nix-flake
 -   ci-run-shim
 -   ci-tests
--   docs-contributing
--   docs-manual
--   docs-readme
+-   doc-contributing
+-   doc-manual
+-   doc-readme
 
 Generated files or extremely common files are not included.  For each one of
 these choices, there is a corresponding command:
@@ -155,11 +155,11 @@ these choices, there is a corresponding command:
 
 -   `erk-find-ci-test`
 
--   `erk-find-docs-contributing`
+-   `erk-find-doc-contributing`
 
--   `erk-find-find-docs-manual`
+-   `erk-find-find-doc-manual`
 
--   `erk-find-docs-readme`
+-   `erk-find-doc-readme`
 
 
 # File contents and structure
@@ -184,7 +184,7 @@ these choices, there is a corresponding command:
     │       ├── ci.yml                    # workflow for lints and tests
     │       └── dco.yml                   # workflow to check DCO sign-offs
     │
-    ├── docs
+    ├── doc
     │   ├── README.org                    # generates README.md
     │   ├── CONTRIBUTING.org              # generates CONTRIBUTING.md
     │   ├── manual.org                    # actual manual
@@ -205,10 +205,10 @@ directories.
 
 You can copy this checklist to your org agenda files:
 
--   [X] Create a repository (from [install](#orgc87b537) instructions)
+-   [X] Create a repository (from [install](#orgff995d3) instructions)
 -   [ ] Create an empty GitHub repository configure it as your git remote
 -   [ ] Set up your git commit signing (and verification so that it's obvious)
-    **and** [sign-off](#org3be8afd) so that it will be hypothetically [straightforward](README.md) for for FSF
+    **and** [sign-off](#orgcf113c3) so that it will be hypothetically [straightforward](README.md) for for FSF
     to pull in your changes if they later change to DCO instead of copyright
     assignment.
 -   [ ] Sign up for [cachix](https://app.cachix.org/) and, create a binary cache with API tokens and public
@@ -234,7 +234,7 @@ You can copy this checklist to your org agenda files:
     **Note**, Python is used to run a DCO check script, nothing more.
 
 -   [ ] Get your package working, pushed, actions run, and CI badges all green
--   [ ] [Publish](#org09c7298) to MELPA
+-   [ ] [Publish](#org9c83480) to MELPA
 -   [ ] Make a post on [reddit](https://reddit.com/r/emacs/) and [mastodon](https://emacs.ch/) about your new package
 
 

diff --git a/doc/erk.texi b/doc/erk.texi
@@ -1,6 +1,6 @@
 \input texinfo    @c -*- texinfo -*-
 @c %**start of header
-@setfilename manual.info
+@setfilename erk.info
 @settitle Elisp Repo Kit
 @documentencoding UTF-8
 @documentlanguage en
@@ -225,7 +225,7 @@ Elisp packages).
 │       ├── ci.yml                    # workflow for lints and tests
 │       └── dco.yml                   # workflow to check DCO sign-offs
 │
-├── docs
+├── doc
 │   ├── README.org                    # generates README.md
 │   ├── CONTRIBUTING.org              # generates CONTRIBUTING.md
 │   ├── manual.org                    # actual manual
@@ -262,7 +262,7 @@ Most of the Elisp shortcuts lean on Emacs settings or packages such as
 
 @itemize
 @item
-The document inputs are stored in /docs.
+The document inputs are stored in /doc.
 @item
 They are @strong{written} in org format
 @item
@@ -427,11 +427,11 @@ ci-run-shim
 @item
 ci-tests
 @item
-docs-contributing
+doc-contributing
 @item
-docs-manual
+doc-manual
 @item
-docs-readme
+doc-readme
 @end itemize
 
 Generated files or extremely common files are not included.  For each one of
@@ -457,20 +457,20 @@ these choices, there is a corresponding command:
 @item
 @code{erk-find-ci-test}
 @end itemize
-@findex erk-find-docs-contributing
+@findex erk-find-doc-contributing
 @itemize
 @item
-@code{erk-find-docs-contributing}
+@code{erk-find-doc-contributing}
 @end itemize
-@findex erk-find-docs-manual
+@findex erk-find-doc-manual
 @itemize
 @item
-@code{erk-find-find-docs-manual}
+@code{erk-find-find-doc-manual}
 @end itemize
-@findex erk-find-docs-readme
+@findex erk-find-doc-readme
 @itemize
 @item
-@code{erk-find-docs-readme}
+@code{erk-find-doc-readme}
 @end itemize
 
 @node Documenting Your Package
@@ -483,15 +483,15 @@ overview:
 @itemize
 @item
 Contents for the README and built-in manual are mostly stored in
-@uref{./manual.org, /docs/manual.org}
+@uref{./manual.org, /doc/manual.org}
 @item
-Each document stitches together the contents of @uref{./manual.org, /docs/manual.org} using
+Each document stitches together the contents of @uref{./manual.org, /doc/manual.org} using
 @samp{#+include:} directives.  Some of the header, footer, and export information
 just controls formatting.
 @item
-The @uref{../README.md, README.md} for your repository's home page is generated from @uref{./README.org, /docs/README.org}
+The @uref{../README.md, README.md} for your repository's home page is generated from @uref{./README.org, /doc/README.org}
 @item
-The @uref{./manual.texi} is generated from @uref{./manual.org, /docs/manual.org}
+The @uref{./erk.texi} is generated from @uref{./manual.org, /doc/manual.org}
 @item
 Re-generation-on-save is automatically configured at the end of each document
 @item
@@ -1060,7 +1060,7 @@ of files that you generally can just copy and enjoy the updates for:
 @item
 .github/pull_request_template.md
 @item
-docs/CONTRIBUTING.org
+doc/CONTRIBUTING.org
 @end itemize
 
 Some files are usually tweaked, but only a little bit.  Drastic overhauls
@@ -1086,9 +1086,9 @@ Other files which occasionally receive updates, but changes that you likely
 
 @itemize
 @item
-docs/README.org
+doc/README.org
 @item
-docs/manual.org
+doc/manual.org
 @end itemize
 
 These files are @strong{generated}, so you can ignore upstream changes even though
@@ -1102,7 +1102,7 @@ README.md
 @item
 CONTRIBUTING.md
 @item
-docs/manual.texi
+doc/erk.texi
 @end itemize
 
 @node Nix