docs: add instructions for updating user documentation during release #292
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #292 +/- ##
=======================================
Coverage 39.82% 39.82%
=======================================
Files 18 18
Lines 2117 2117
Branches 257 257
=======================================
Hits 843 843
Misses 1222 1222
Partials 52 52 ☔ View full report in Codecov by Sentry. |
|
This Pull Request introduces changes to the README.md file, adding a new section for updating the user documentation. The changes are limited to the documentation and do not involve modifications to the core functionality or architecture of the project. The addition of this section is unlikely to introduce bugs or have any significant impact on the codebase. The changes are straightforward and can be easily reviewed by a developer familiar with the project's documentation style and tools. Therefore, this PR is categorized as 'BLUE'. However, please note that even though the changes are categorized as 'BLUE', it is still important to review the PR to ensure the documentation is accurate and clear. |
In the generated doc the sub command description were being shortened,
for example:
allocate: Notify a CRN to start an instance (for...
confidential: Create (optional), start and unlock a...
Solution:
Vendroize and customize the tool to generate the doc
Switch the char limit from 45 to 1000
It will still only take the first paragraph
Related ClickUp, GitHub or Jira tickets : ALEPH-240
Self proofreading checklist