Create a user guide with more detailed examples

[eonu]

Does this suggestion already exist?

• This is a new feature!

Feature description

The current Sphinx-generated API reference is useful for learning basic usage patterns of the package.

However, there are many features of Feud, or ways to combine features that can be used in more complex usage patterns to achieve many different things in the generated CLI.

These detailed usage examples don't belong in the API reference, and should be contained in a separate user guide.

The user guide should also show integrations (which should work in theory), e.g. click-contrib and trogon.

Proposed stack

• mkdocs
  • mkdocs-material: Material design for mkdocs
  • koaning/mktestdocs: doctest but for mkdocs
  • jimporter/mike: multi-version mkdocs documentation
  • mkdocs-plugins/termynal: terminal window plugin for code blocks

---

Hosted at feud.wiki/guide or guide.feud.wiki.