Documentation Site

[austin-weeks]

Add a dedicated documentation site (hosted on GitHub Pages) that includes more in-depth information on the project.

Topics I'd like to include:

• Installation options
• Configuration Options
• Library Usage
• Integration with Various Gateways
  • Nginx
  • Apache
  • Kong
  • Caddy
  • ...others as suggested by the community
• How to trap bots (this section already exists in the README)

[HeadedBranch]

There is already documentation (generated from the code) available at https://docs.rs/miasma/latest/miasma/ which you could potentially use, it would probably be the best at least for the library usage goal, as it is the default place for rust documentation

[sermuns]

There is already documentation (generated from the code) available at https://docs.rs/miasma/latest/miasma/ which you could potentially use, it would probably be the best at least for the library usage goal, as it is the default place for rust documentation

I think the distinction between docs.rs and your own documentations is, docs.rs is reference for the Rust API, but standalone documentation can be as free-form as it wants!

[sermuns]

I recommend either mdBook or Zensical!

[Nold360]

I will just leave this here since this plugin is perfect for miasma:

---
apiVersion: traefik.io/v1alpha1
kind: Middleware
metadata:
  name: bot-wrangler
spec:
  plugin:
    bot-wrangler:
      enabled: true
      botAction: PROXY
      botProxyUrl: "http://miasma.miasma.svc.cluster.local:9999"