charlesLoder/hebrew-transliteration

Improve documentation

Opened this issue · 1 comments

charlesLoder commented

The documentation is lacking.

Though the code is documented decently enough for intellisense, there should be better documentation.

Typedoc is nice to generate docs from code, but it kind of a pain for making things look nice or easily navigable.

Look into docusaurus

charlesLoder commented

Thoughts:

  • Typedoc to generate some JSON
  • maybe custom script to convert json to markdown
  • use Starlight for markdown
  • host on GH Pages (see also here)
  • like havarotjs, it should be it's own branch