Lack of documentation about release options object in nx.json in web and code
Opened this issue · 0 comments
JoseAntpr commented
Documentation issue
- Reporting a typo
- Reporting a documentation bug
- Documentation improvement
- Documentation feedback
Is there a specific documentation page you are reporting?
https://nx.dev/nx-api/devkit/documents/NxJsonConfiguration#release
https://nx.dev/features/manage-releases#using-the-programmatic-api-for-nx-release
Additional context or description
Official documentation has a lack of information about release options. I think could be very helpful to have all the possible options in the documentation.
Also inside the code when you check the different documentation you need to navigate a lot to find things like generatorOptions and will be very helpful to be linked in the official documentation.
Regarding checking the generatorSchema I think each option need to have a description of the property itself. Some of them have description and other not.
Same for Programatic API. It is a poweful feature but difficult to understand how to do a good approach to apply in a project.