codecharta
codecharta copied to clipboard
Update GitHub Pages for Users & READMEs for Developers (CodeCharta Documentation)
Update GitHub Pages (CodeCharta Documentation) Update README's (Github)
Split the general documentation for CodeCharta into two parts for Developers & Users
Some parts need to be modified [ New: π Changing: π¨ Keep: βοΈ Discuss: β ]
- GitHub Pages
-
- π¨ User focused documentation
-
- βοΈ How-to's and specific use cases
-
- π¨ User installation guide
-
- βοΈ Release Posts
-
- β ADR
-
- βοΈ Versioning / Price / Feedback
-
- π Auto copy of technical README's (if possible) or links to README's
- READMEs (Github)
-
- βοΈTechnical documentation (CLI usage, flags)
-
- π Developer setup guide
-
- π¨ Introductory README's
The entry point in both sections should have a strong link/reference for users/developers to switch to the (more) appropriate documentation