From 56e17bef01d46c23c520fb39046d81e0637d88f6 Mon Sep 17 00:00:00 2001 From: Jeroen Ouwehand Date: Tue, 11 Jun 2019 12:42:30 +0200 Subject: [PATCH 1/2] Added the reference of the 'CGX' CLI to the README so people can easily generate documentation --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 26568c2..09622ec 100644 --- a/README.md +++ b/README.md @@ -111,6 +111,8 @@ Even if for some reason they have to use it because they have no choice, without 2. [documentation-handbook](https://github.com/jamiebuilds/documentation-handbook) - _jamiebuilds_ 3. [Documentation Guide](https://www.writethedocs.org/guide/) - _Write the Docs_ +## 📦 CGX CLI +[CGX](https://github.com/jeroenouw/cgx) - Generate all the recommended documentation/files (pre-filled) for the Github and Gitlab community standards. (Issue templates, code of conduct, etc) ## ✋ P.S. From f615e05a296596663f7eeb3937ee4779caaa7df1 Mon Sep 17 00:00:00 2001 From: Jeroen Ouwehand Date: Thu, 13 Jun 2019 08:21:55 +0200 Subject: [PATCH 2/2] Moved CGX template generator under templates as subpoint --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 09622ec..de8dc68 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,7 @@ - [Why must you document your project](#why_document) - [Best Practices](#best_practices) - [Templates](#templates) + - [CGX CLI: Template generator](https://github.com/jeroenouw/cgx) - The Art of Technical Writing - [Novice Technical Writers](https://www.writethedocs.org/guide/#new-to-caring-about-documentation) - [Experienced Technical Writers](https://www.writethedocs.org/guide/#experienced-documentarian) @@ -82,6 +83,9 @@ Even if for some reason they have to use it because they have no choice, without - [Codebase Structure](/CODEBASE_STRUCTURE.md) - [TODO](/TODO.md) +**📦 CGX CLI: Template generator:** + +[CGX](https://github.com/jeroenouw/cgx) - Generate all the recommended documentation/files (pre-filled) for the Github and Gitlab community standards. (Issue templates, code of conduct, etc) ## 👨‍💻 Technical Writing Programs @@ -111,8 +115,6 @@ Even if for some reason they have to use it because they have no choice, without 2. [documentation-handbook](https://github.com/jamiebuilds/documentation-handbook) - _jamiebuilds_ 3. [Documentation Guide](https://www.writethedocs.org/guide/) - _Write the Docs_ -## 📦 CGX CLI -[CGX](https://github.com/jeroenouw/cgx) - Generate all the recommended documentation/files (pre-filled) for the Github and Gitlab community standards. (Issue templates, code of conduct, etc) ## ✋ P.S.