chore(docs): rename documentation files

abougouffa · Jan 3, 2025 · 2e867d1 · 2e867d1
1 parent 33ce5ea
commit 2e867d1
Show file tree

Hide file tree

Showing 10 changed files with 10 additions and 10 deletions.
diff --git a/Makefile b/Makefile
@@ -61,10 +61,10 @@ ci-daemon:
 	HOME=$(PWD)/.. timeout 180 $(EMACS) --daemon 2>&1
 
 gen-descriptions:
-	$(EMACS_BATCH) --eval='(progn (minemacs-extract-packages-descriptions) (with-current-buffer (get-buffer "*minemacs-modules-pkg-desc*") (write-file "docs/PACKAGES.md")))'
+	$(EMACS_BATCH) --eval='(progn (minemacs-extract-packages-descriptions) (with-current-buffer (get-buffer "*minemacs-modules-pkg-desc*") (write-file "docs/packages.md")))'
 
 gen-external-tools:
-	$(EMACS_BATCH) --eval='(progn (+list-external-dependencies) (with-current-buffer (get-buffer "*external-dependencies*") (write-file "docs/EXTERNAL-TOOLS.md")))'
+	$(EMACS_BATCH) --eval='(progn (+list-external-dependencies) (with-current-buffer (get-buffer "*external-dependencies*") (write-file "docs/external-tools.md")))'
 
 make-readme-markdown.el:
 	wget -q -O $@ https://raw.github.com/mgalgs/make-readme-markdown/master/make-readme-markdown.el
@@ -73,6 +73,6 @@ combined.el:
 	cat init.el early-init.el core/me-{vars,lib,lib-extra,builtin}.el modules/me-*.el modules/extras/me-*.el >combined.el
 
 documentation: gen-descriptions gen-external-tools combined.el make-readme-markdown.el
-	emacs --script make-readme-markdown.el <combined.el >docs/DOCS.md 2>/dev/null
+	emacs --script make-readme-markdown.el <combined.el >docs/functions-and-commands.md 2>/dev/null
 
 .INTERMEDIATE: make-readme-markdown.el combined.el
diff --git a/README.md b/README.md
@@ -1 +1 @@
-docs/README.md
+docs/readme.md
diff --git a/cog.toml b/cog.toml
@@ -18,7 +18,7 @@ tweak = { changelog_title = "Tweaks" }
 nit = { changelog_title = "Nitpicks, changes with no side effect" }
 
 [changelog]
-path = "docs/CHANGELOG.md"
+path = "docs/changelog.md"
 template = "remote"
 remote = "github.com"
 repository = "minemacs"

diff --git a/docs/CHANGELOG.md → docs/changelog.md b/docs/CHANGELOG.md → docs/changelog.md
diff --git a/docs/EXTERNAL-TOOLS.md → docs/external-tools.md b/docs/EXTERNAL-TOOLS.md → docs/external-tools.md
diff --git a/docs/FAQ.md → docs/faq.md b/docs/FAQ.md → docs/faq.md
diff --git a/docs/DOCS.md → docs/functions-and-commands.md b/docs/DOCS.md → docs/functions-and-commands.md
diff --git a/docs/PACKAGES.md → docs/packages.md b/docs/PACKAGES.md → docs/packages.md
diff --git a/docs/README.md → docs/readme.md b/docs/README.md → docs/readme.md
@@ -12,11 +12,11 @@
 
 ## Why?
 
-[Long story](docs/STORY.md) short, I'm relaying on Emacs for my everyday's
+[Long story](docs/story.md) short, I'm relaying on Emacs for my everyday's
 work, so I needed a fast and stable configuration that fits my needs. MinEmacs
-is changing constantly, please refer to the [change log](docs/CHANGELOG.md) for
+is changing constantly, please refer to the [change log](docs/changelog.md) for
 more information. See also the [list of MinEmacs' modules and
-packages](docs/PACKAGES.md).
+packages](docs/packages.md).
 
 > [!NOTE]
 > Please note that I have no intent or availability to create an alternative to
@@ -169,11 +169,11 @@ You can customize MinEmacs' behavior via some environment variables.
 ## Extra documentation
 For more information about customization variables, functions and commands
 defined by MinEmacs, you can refer to the [documentation generated from the
-source code](docs/DOCS.md).
+source code](docs/functions-and-commands.md).
 
 ## Troubleshooting
 
 If you experienced an issue with MinEmacs, you can take a look at the
-[FAQ](docs/FAQ.md), consult the
+[FAQ](docs/faq.md), consult the
 [discussions](https://github.com/abougouffa/minemacs/discussions), check [open
 issues or open a new one](https://github.com/abougouffa/minemacs/issues).
diff --git a/docs/STORY.md → docs/story.md b/docs/STORY.md → docs/story.md