Human-friendly documentation

[zachallaun]

This is a meta-issue to track changes and discussion related to Mneme's documentation. These changes are guided by Diátaxis (hat tip @erikareads), but strict adherence to that system is not a goal in and of itself.

This list in incomplete and may change, but things that I can think of right now:

• Separate README from the Mneme moduledoc. The README should become the landing page for https://hexdocs.pm/mneme (done on main).
• Create a catalog of features/examples:
  • Start with a single docs/examples.md with as many examples as possible. Organization isn't important here, focus on being comprehensive.
  • Use vhs to create short, digestible gifs for examples where it makes sense.
  • (Future) Automate/generate example output when mix docs is run to ensure they're up-to-date.
• Create How-To's for different workflows.
• Create a tutorial.
  • (Idea) Implement the tutorial using Livebook. This would probably require the use of the SmartCell editor feature to access the source of the tests, but would allow for things to be very interactive with extremely minimal setup.

[zachallaun]

See e907500...411ea45 for changes I made as a part of this earlier today.