Skip to content

Commit 1edddff

Browse files
authored
Add information about contributing to the CLI documentation. (#2649)
* Add information about contributing to the CLI documentation. * Fix typo
1 parent ddd8328 commit 1edddff

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

CONTRIBUTING.md

+13
Original file line numberDiff line numberDiff line change
@@ -105,5 +105,18 @@ When the patch is reviewed and merged, you can safely delete your branch and pul
105105

106106
[Back to Top][1]
107107

108+
Updating the CLI documentation
109+
===
110+
111+
The CLI documentation is what you see when running the `tns help` command.
112+
This documentation is distributed as part of the CLI package and is generated from the *.md files that can be found in <a href="https://github.com/NativeScript/nativescript-cli/tree/master/docs/man_pages" target="_blank">man_pages folder</a>
113+
The output of the documentation is html static pages that are generated on post install hook of the CLI installation.
114+
In addition, documentation generation is triggered every time there is no html article for the respective help command that is executed.
115+
116+
In order to see a change applied in your development workspace after editing the *.md files, you can use the `tns dev-generate-help` command.
117+
This will trigger regeneration of all html files on your local environment. Mind that you need to run from the /bin folder of the nativescript_cli.
118+
119+
[Back to Top][1]
120+
108121
[1]: #contribute-to-the-telerik-nativescript-command-line-interface
109122
[2]: https://github.com/NativeScript/nativescript-cli

0 commit comments

Comments
 (0)