docs: Redo documentation to centralize info and cleanly showcase defender's capabilities in one place.

[JasonLovesDoggo]

Looking for help here!

[aleho]

I can do that next week if you want to. I struggled with the configuration, so I know what I'd need.

[JasonLovesDoggo]

I can do that next week if you want to. I struggled with the configuration, so I know what I'd need.

Thank you very much! Any questions feel to ask.

Ideally, this centralizes docs/* examples/* and the README's docs into a new docs/* with github actions building this into a github pages site with something like https://squidfunk.github.io/mkdocs-material/

I also have some random stuff in benchmarks/* CONTRIBUTING.md and fetchers/README.md

Do note, the docs don't fully mention whitelisting & geoip (as it's a WIP) right now.

for geoip the structure would be

geoip {
   db_path /path/to/file.mmdb
   cache_ttl  40s
}

as defined by

type Config struct {
   DatabasePath string
   CacheTTL     time.Duration
}

[JasonLovesDoggo]

Would be nice to look into caddy's doc format and fix https://caddyserver.com/docs/modules/http.handlers.defender

see https://caddyserver.com/docs/extending-caddy#caddy-struct-tags

[JasonLovesDoggo]

I can do that next week if you want to. I struggled with the configuration, so I know what I'd need.

Any updates?

[aleho]

Sorry, I was so preoccupied with work and personal life I couldn't do anything else.

Initially I thought I'd just consolidate all the *.md in this project, which would have been a quick task, but your additional requirements for a GitHub page and automatic Caddy docs "discouraged" me from ever starting to look into it.

[JasonLovesDoggo]

Sorry, I was so preoccupied with work and personal life I couldn't do anything else.

Initially I thought I'd just consolidate all the *.md in this project, which would have been a quick task, but your additional requirements for a GitHub page and automatic Caddy docs "discouraged" me from ever starting to look into it.

Ah gotcha. That's all good. I was just checking if it was stale.