Simplify things for end-users

[badlydrawnrob]

Aimed predominantly at beginners and intermediates.
Professional build is being removed, but link back to previous versions.
Install. Update. Pandoc builds. Issues.

Write up some simple examples

• Good and bad card examples for [type of card]
  • Good (and bad) examples of cards #114
• Simplify initial README so it's easier to digest
  • Show it, don't say it. Gifs and videos.
  • How to use Anki and creating cards #123 (condense and simplify)
  • A simple PDF for instructions?
• Compiler stuff is hidden until required (intermediate)
  • This takes considerable amount of teaching
• Common pain points handled with a FAQ etc
  - See Discourse new user tips and tricks for good example

Other things

• Aim to keep issues simple
  • Personal issues should remain personal (e.g. Auto update package.json? #102)
  • Perhaps a tags are enough: "don't worry about this!", "for beginners only", etc
• Updating Anki deck #42 updates should be inviting and simple.
  • The briefest of notes on this in the README and the UPDATE
• A very brief word on security
  • Getting syntax highlighting to work #25
  • In the link above, Pandoc commands are by no means obvious.
  • Use npm, but a couple of notes on how to use Pandoc.¹
• Badges and questions
  • I've barely had any questions or user-led issues, so no need for templates yet
  • Perhaps a simple sentence/section like this forum
  • Simple instructions for "Learn", "Show and Tell", etc, if they want.²
• Regularly check links are working
  • From time to time, easiest way for internal links is to hover over link in Visual Studio Code³
  • This can also be done with the Marked App (external links at least) Preview -> Validate External Links
• Semantic Versioning is a useful reminder
  • Make json easier #44
• Simplify and gut some features #135
  • Make sure the data files work smoothly with Pandoc
  • I feel the stripped versions are quicker to use.

Footnotes

1. We're not using templates or anything like that, but it's helpful to note you can change the theme easily if you want to, either by editing the --css-variables or --highlight-style and manually editing the css. I don't think I'll include all the themes by default as some of them are a bit rubbish. ↩

2. So far the way I've approached this has been unsuccessful. I don't really know how often people are using this tool, or how long it serves them. At least one person has a very old version, and another only needed it for a very short spell. ↩

3. Using a link check tool online is another option, but it display all Github's links too. ↩