docs: Use the docs folder more

Also rename it from doc to docs

Signed-off-by: Sam Therapy <sam@samtherapy.net>

.gitignore

@@ -23,7 +23,7 @@ coverage/*
 !coverage/.gitkeep
 
 awl
-doc/awl.1
-doc/awl.1.gz
+docs/awl.1
+docs/awl.1.gz
 
 .dccache

.gitmodules

@@ -1,3 +1,3 @@
-[submodule "doc/wiki"]
-	path = doc/wiki
+[submodule "docs/wiki"]
+	path = docs/wiki
 	url = ../awl.wiki

.goreleaser.yaml

@@ -5,7 +5,7 @@ before:
     - make clean
     - go mod tidy
     # Make manpages
-    - doc/makeman.sh
+    - docs/makeman.sh
     # Vendor dependencies
     - go mod vendor
 
@@ -21,7 +21,7 @@ archives:
   - files:
       - LICENSE
       - completions/**
-      - doc/awl.1.gz
+      - docs/awl.1.gz
     name_template: >-
       {{ .ProjectName }}_
       {{- if eq .Os "darwin" }}MacOS_
@@ -88,7 +88,7 @@ brews:
       bash_completion.install "completions/bash.bash" => "awl"
       zsh_completion.install "completions/zsh.zsh" => "_awl"
       fish_completion.install "completions/fish.fish" => "awl.fish"
-      man1.install "doc/awl.1.gz"
+      man1.install "docs/awl.1.gz"
 
 scoops:
   - repository:
@@ -108,7 +108,7 @@ nix:
     description: A DNS query client
     license: bsd3
     extra_install: |-
-      installManPage ./doc/awl.1.gz
+      installManPage ./docs/awl.1.gz
       installShellCompletion ./completions/*
 
 nfpms:
@@ -131,10 +131,10 @@ nfpms:
     contents:
       - src: completions/bash.bash
         dst: /usr/share/bash-completion/completions/awl
-      - src: doc/awl.1.gz
+      - src: docs/awl.1.gz
         dst: /usr/share/man/man1/awl.1.gz
       - src: LICENSE
-        dst: /usr/share/doc/awl/copyright
+        dst: /usr/share/docs/awl/copyright
       - src: completions/fish.fish
         dst: /usr/share/fish/vendor_completions.d/awl.fish
       # DEB only

GNUmakefile

@@ -22,7 +22,7 @@ install:
 else
 install: all
 	install -$(INSTALLFLAGS)m755 $(PROG) $(DESTDIR)$(PREFIX)/$(BIN)/$(PROG)
-	install -$(INSTALLFLAGS)m644 doc/$(PROG).1 $(DESTDIR)$(MAN)/man1/$(PROG).1
+	install -$(INSTALLFLAGS)m644 docs/$(PROG).1 $(DESTDIR)$(MAN)/man1/$(PROG).1
 # completions need to go in one specific place :)
 	install -$(INSTALLFLAGS)m644 completions/bash.bash $(DESTDIR)$(PREFIX)/$(SHARE)/bash-completion/completions/$(PROG)
 	install -$(INSTALLFLAGS)m644 completions/fish.fish $(DESTDIR)$(PREFIX)/$(SHARE)/fish/vendor_completions.d/$(PROG).fish

Makefile

@@ -9,7 +9,7 @@ EXE := $(PROG)
 .PHONY: install
 install: all
 	install -Dm755 $(PROG) $(DESTDIR)$(PREFIX)/$(BIN)/$(PROG)
-	install -Dm644 doc/$(PROG).1 $(DESTDIR)$(MAN)/man1/$(PROG).1
+	install -Dm644 docs/$(PROG).1 $(DESTDIR)$(MAN)/man1/$(PROG).1
 # completions need to go in one specific place :)
 	install -Dm644 completions/bash.bash $(DESTDIR)$(PREFIX)$(SHARE)/bash-completion/completions/$(PROG)
 	install -Dm644 completions/fish.fish $(DESTDIR)$(PREFIX)$(SHARE)/fish/vendor_completions.d/$(PROG).fish

README.md

@@ -1,5 +1,5 @@
 <!-- markdownlint-disable MD033 -->
-# <img src="./doc/img/awl-text.png" width="50%" title="awl logo" alt="awl">
+# <img src="./docs/img/awl-text.png" width="50%" title="awl logo" alt="awl">
 
 > awl *(noun)*: A pointed tool for making small holes in wood or leather
 
@@ -158,7 +158,7 @@ scoop install awl
 
 ## Contributing
 
-Please see the [CONTRIBUTING.md](./CONTRIBUTING.md) file for more information.
+Please see the [CONTRIBUTING.md](./docs/CONTRIBUTING.md) file for more information.
 
 TL;DR: If you like the project, spread the word! If you want to contribute, [use the issue tracker](https://git.froth.zone/sam/awl/issues) or [open a pull request](https://git.froth.zone/sam/awl/pulls).
 Want to use email instead? Use our [mailing list](https://lists.sr.ht/~sammefishe/awl-devel)!

doc/makeman.sh

@@ -1,7 +0,0 @@
-#!/bin/sh
-
-set -e
-
-rm -f doc/awl.1.gz
-scdoc <doc/awl.1.scd >doc/awl.1
-gzip -9 -n doc/awl.1

docs/makeman.sh

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+set -e
+
+rm -f docs/awl.1.gz
+scdoc <docs/awl.1.scd >docs/awl.1
+gzip -9 -n docs/awl.1

mkfile

@@ -17,7 +17,7 @@ $PROG:
 
 install:V:
   $GO install $GOFLAGS  .
-  # cp doc/$PROG.1 /sys/man/1/$PROG
+  # cp docs/$PROG.1 /sys/man/1/$PROG
 
 test:V:
   $GO test -v -cover ./...

pkg/query/struct.go

@@ -61,7 +61,7 @@ type Answer struct {
 
 // EDNS0 is for all EDNS options.
 //
-// RFC: https://datatracker.ietf.org/doc/draft-peltan-edns-presentation-format/
+// RFC: https://datatracker.ietf.org/docs/draft-peltan-edns-presentation-format/
 //
 //nolint:govet,tagliatelle
 type EDNS0 struct {

snap/snapcraft.yaml

@@ -8,7 +8,7 @@ license: BSD-3-Clause
 summary: A command-line DNS query tool.
 description: |
   awl is a command line DNS tool, much like dig and drill.
-icon: doc/img/awl.svg
+icon: docs/img/awl.svg
 issues:
   - https://git.froth.zone/sam/awl/issues
   - ~sammefishe/awl-devel@lists.sr.ht

template.mk

@@ -23,19 +23,19 @@ MAN ?= $(PREFIX)/$(SHARE)/man
 PROG ?= awl
 
 # hehe
-all: $(PROG) doc/$(PROG).1
+all: $(PROG) docs/$(PROG).1
 
 $(PROG): $(SOURCES)
 	$(GO) build -o $(EXE) $(GOFLAGS) .
 
-doc/$(PROG).1: doc/$(PROG).1.scd
+docs/$(PROG).1: docs/$(PROG).1.scd
 	$(SCDOC) <$? >$@
 
-doc/wiki/$(PROG).1.md: doc/$(PROG).1
+docs/wiki/$(PROG).1.md: docs/$(PROG).1
 	pandoc --from man --to gfm -o $@ $?
 
 ## update_doc: update documentation (requires pandoc)
-update_doc: doc/wiki/$(PROG).1.md
+update_doc: docs/wiki/$(PROG).1.md
 
 .PHONY: fmt
 fmt:
@@ -87,7 +87,7 @@ cover: coverage/cover.html
 clean:
 	$(GO) clean
 # Ignore errors if you remove something that doesn't exist
-	rm -f doc/$(PROG).1
+	rm -f docs/$(PROG).1
 	rm -f coverage/cover*
 	rm -rf vendor