After completing this user story, content creators will be able to create documents for plugins, actions, stacks and starters through a single file generated in the content creator's local directory once they give the command to create one of these contents via the CLI .
Intended Outcome
The successful improvement of this story brings benefits in terms of maintaining documentation close to the code of the created content. Just as it will no longer be necessary to create a new version of a plugin or action whenever you need to update the documentation, as we will have a command in the CLI with the possibility of updating the documentation. Another perceived benefit is the possibility of creating documentation for the stack and starter, where in the current version this is not possible, with the possibility of updating without creating a new version of the Stack.
How It Will Work
When content creators enter the commands to create a plugin, action, stack or starter in the CLI, a file for documentation in Portuguese and a file for documentation in English will be generated in the local directory. Once the contents have been published on the portal, the files written using standard markdown will be rendered and made available on the respective documentation page for each of the published contents.
If the content creator has blank documentation, they can access the StackSpot platform and be directed to a product documentation page that teaches how to create documentation, or if the content creator wants to update the documentation, they can also access the platform is directed to a product documentation page that provides information about updating documentation. However, if the content creator wants to create the documentation or update it, he simply needs to edit the files available in the local directory, access the CLI and enter the command corresponding to this action.
Description
After completing this user story, content creators will be able to create documents for plugins, actions, stacks and starters through a single file generated in the content creator's local directory once they give the command to create one of these contents via the CLI .
Intended Outcome
The successful improvement of this story brings benefits in terms of maintaining documentation close to the code of the created content. Just as it will no longer be necessary to create a new version of a plugin or action whenever you need to update the documentation, as we will have a command in the CLI with the possibility of updating the documentation. Another perceived benefit is the possibility of creating documentation for the stack and starter, where in the current version this is not possible, with the possibility of updating without creating a new version of the Stack.
How It Will Work
When content creators enter the commands to create a plugin, action, stack or starter in the CLI, a file for documentation in Portuguese and a file for documentation in English will be generated in the local directory. Once the contents have been published on the portal, the files written using standard markdown will be rendered and made available on the respective documentation page for each of the published contents. If the content creator has blank documentation, they can access the StackSpot platform and be directed to a product documentation page that teaches how to create documentation, or if the content creator wants to update the documentation, they can also access the platform is directed to a product documentation page that provides information about updating documentation. However, if the content creator wants to create the documentation or update it, he simply needs to edit the files available in the local directory, access the CLI and enter the command corresponding to this action.
Preview Feature