BuilderIO/mitosis

Lackluster developer docs

markusbkk opened this issue · 1 comments

I am interested in helping provide a fix!

Yes

Which generators are impacted?

  • All
  • Angular
  • HTML
  • Preact
  • Qwik
  • React
  • React-Native
  • Solid
  • Stencil
  • Svelte
  • Vue
  • Web components

Reproduction case

N/A

Expected Behaviour

Documentation on how to build and run things like the Mitosis CLI locally.

Actual Behaviour

The documentation merely states to run yarn start, which doesn't actually engage the CLI.

Additional Information

I'm interested in developing a generator for my Go-based component framework. Unfortunately, I'm unable to figure out how to make local changes to the CLI.

yarn start doesn't engage the CLI and yarn build produces a dist/ folder but running node dist/cli.js doesn't produce any output.

Have you read https://github.com/BuilderIO/mitosis/blob/main/developer/generators.md ? It includes a walkthrough of how to add a new generator