Nv 3901 update docs - Githubissues

novuhq / docs

Novu documentation - The Masterpiece

https://docs.novu.co

39 stars 78 forks source link

Nv 3901 update docs #625

Closed denis-kralj-novu closed 2 weeks ago

denis-kralj-novu commented 2 weeks ago

Preview deployment: https://novu-preview-nv-3901-update-docs.mintlify.app/framework

linear[bot] commented 2 weeks ago

NV-3901 Update docs

denis-kralj-novu commented 2 weeks ago

Some details that should also be addressed:

~example repositories have echo in their name, these should be renamed before we update these references~ done
the same example repositories also need to be updated to use the new @novu/framework package and new workflow definition method
~what is the future of the local studio after June? should we update those docs or should we wait for the June release and then retire studio (maybe I misunderstood what the goal is with it)~ discussed and agreed to defer until we settle on a flow

denis-kralj-novu commented 2 weeks ago

there is a file called echo-terminal.js that states it should not be renamed (so I assume also moved) as it is referenced externally. Won't do anything to it given that it doesn't show up to the public

denis-kralj-novu commented 2 weeks ago

I would need someone to show me how to edit the content of the echo-terminal used in the docs, so that I can reflect the new coding style we are transitioning to

rifont commented 2 weeks ago

there is a file called echo-terminal.js that states it should not be renamed (so I assume also moved) as it is referenced externally. Won't do anything to it given that it doesn't show up to the public

Let's sync about this renaming and restructuring.