Documentation

[Taitava]

Discussed in #99

Create documentation topics for:

• Basics:
  • Add instructions about basic command set up
  • Installation (a link to README.md)
• Example shell commands:
  • Note for each example shell command
  • Add Mac and Linux versions, too
• Operating systems and shells:
  • Operating system specific versions of shell commands + shell selection #76
• Output handling:
  • Ignoring errors
  • Output channels
• Variables:
  • A note for each variable
  • Variable values should be escaped #11: Escaping special characters in variable values
  • Arguments for variables
• Upgrading:
  • About Semantic versioning
  • How to upgrade
  • Tell about automatic backups + mention that user should take manual backups, too
  • How to downgrade if problems occur

[Taitava]

The documentation will be available in Obsidian Publish.

Also add to settings:

• Link to the documentation front page
• Link to variables in documentation (located in the variables section in settings, with text like "See these instructions also in the documentation")
• Link to this GitHub repository

[Taitava]

Done.