In service of making this repo easier to consume (both by users and maintainers) we need to improve the documentation.

Here, I note important issues, discussions, etc that are relevant:

Issues

• Document as own website #22
  • docs(demo): Create a demo website #46
  • docs: remove old documentation and add a new one #49
• docs(codeowner): add codeowners file for clear reviews #18
• docs(changelog): Changelog is still at version 4.0.0 #33
• build: Create a devcontainer for the project #73

Ideal End State for Docs

Generally speaking, I think most of these docs should be a part of this codebase, not a separate app. The chief concern here is that the further the docs are from the code, the more likely they are to become stale.

• Autogenerated API docs based upon doc blocks on methods and properties
  • Depends on Typescript Migration
  • chore: add typedoc #82
• General guides for usage
  • Should exist in the docs folder
    • Review what is already in the docs folder
• Written tutorials
  • General walkthrough of the how to setup and install the code
    • In a simple browser project
    • In a NodeJS project
    • In a Typescript project
• A general playground for messing with Faker