Open florian-lefebvre opened 1 year ago
@florian-lefebvre agree on this one. Will need to make some order in the way we release the docs and code version. right now it's a bit a mess. Will discuss it over discord to find a good structure of managing releases. Any suggestions or places where you saw it work good?
I think #14 might solve this, at least partially. Maybe we can have a look at how they do it at https://github.com/medusajs/medusa? In docs and packages/medusa-js
Seems like a mix of a develop
branch and master
branch, I believe. I think we might head in a similar direction too.
Yes absolutely, I tend to use this pattern a lot. The master is what goes to production. So for instance, docs should be pushed to the master branch (talking about the monorepo there)
Currently, adding code snippets to the code-examples directory show only them in the api docs. For instance :
Node.js
is the only available snippetI suggest the custom snippets only act as an override for the language, so that other ones (for instance Go or Python) can remain. This is critical IMO because changes we make do not wait on the release of the next version of the clients from the monorepo. For instance, #15 added a custom snippet because the related code has been merged in the monorepo but v9 is not released yet (https://github.com/novuhq/novu/pull/1261), so people can't see other way of doing this.
cc @scopsy