codecharta icon indicating copy to clipboard operation
codecharta copied to clipboard

Update GitHub Pages for Users & READMEs for Developers (CodeCharta Documentation)

Open ce-bo opened this issue 3 years ago β€’ 0 comments

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

ce-bo avatar Jun 07 '22 09:06 ce-bo