info/the-documentation-compendium
1
0
Fork 0
mirror of https://github.com/kylelobo/The-Documentation-Compendium.git synced 2025-09-03 10:02:41 +02:00
Code Issues Releases Wiki Activity

Merge pull request #16 from jeroenouw/cgx

Browse Source 
Add  'CGX' CLI to the README
This commit is contained in:
Kyle Lobo
2019-06-13 21:39:43 +05:30
committed by GitHub
parent 2c9c5beac4 f615e05a29
commit d18a568ceb
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -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 <a name = "programs"></a>