wa-automate-nodejs icon indicating copy to clipboard operation
wa-automate-nodejs copied to clipboard

Migrate off typedoc

Open smashah opened this issue 3 years ago • 3 comments

It's unmaintained plugins is now blocking progress of this lib.

I need extensive generation + ability to add guides/tutorials

https://github.com/topics/documentation?l=typescript

Options:

  • https://github.com/facebook/docusaurus [eww facebook]
  • https://tsdoc.org/

smashah avatar Feb 01 '22 22:02 smashah

Decided on docusaurus.

Switch has been made for main site but following still needs completing:

  • [ ] CI/CD generate on build
  • [ ] Add latest version number on navbar
  • [ ] Add latest patch hash on navbar (on build?)
  • [ ] Add pricing page for licenses
  • [ ] Add pricing tool tip for gumroad links
  • [ ] Make a compelling home page
  • [ ] Replace placeholder docs with intuitive documentation flow
  • [ ] How To: Rapid development
  • [ ] Add socket client as a first party tutorial
  • [ ] Add testimonials on landing page

smashah avatar Aug 14 '22 22:08 smashah

  • [x] Update license how to docs with a switchable codeblock for CLI/Custom Code

Going forward, CLI is priority

smashah avatar Aug 16 '22 14:08 smashah

  • [ ] Integration docs:
  • [ ] Node-red
  • [ ] chatwoot

smashah avatar Aug 22 '22 18:08 smashah