Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Open
ce-bo opened this issue Jun 7, 2022 · 0 comments
Open

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

ce-bo opened this issue Jun 7, 2022 · 0 comments
Labels
documentation priority:high Set by PO

Comments

@ce-bo
Copy link
Collaborator

ce-bo commented Jun 7, 2022 •
edited by phanlezz

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 ce-bo added priority:high Set by PO and removed priority:medium Set by PO labels Jun 30, 2022
@phanlezz phanlezz self-assigned this Aug 2, 2022
knoffi added a commit that referenced this issue Aug 2, 2022
@knoffi @phanlezz
Update readme of csv exporter #2834
687e6d0 
Co-authored-by: phanlezz <phanlezz@users.noreply.github.com>
@knoffi knoffi mentioned this issue Aug 2, 2022
Merged
knoffi added a commit that referenced this issue Aug 2, 2022
@knoffi
Add example of path truncating in README #2834
9eb6073
phanlezz added a commit that referenced this issue Aug 2, 2022
@knoffi @phanlezz
Update readme of csv exporter #2834 (#2927)
90a8770 
* Update readme of csv exporter #2834

* Add example of path truncating in README #2834

Co-authored-by: phanlezz <phanlezz@users.noreply.github.com>
knoffi added a commit that referenced this issue Aug 3, 2022
@knoffi
Document the short help-flag of csv export #2834
b8a4b86
knoffi added a commit that referenced this issue Aug 3, 2022
@knoffi
Update visualization readme #2834
fa8c6f7
@knoffi knoffi mentioned this issue Aug 3, 2022
Merged
@phanlezz phanlezz removed their assignment Aug 9, 2022
phanlezz added a commit that referenced this issue Aug 10, 2022
@phanlezz
Add more instructions in-progress #2834
a34158c
phanlezz added a commit that referenced this issue Aug 10, 2022
@phanlezz
Add more instructions in-progress #2834
1ceb5cc
phanlezz added a commit that referenced this issue Aug 11, 2022
@phanlezz
Finalize description for visualization installation and usage #2834
0e81622
phanlezz added a commit that referenced this issue Aug 12, 2022
@knoffi @phanlezz
Docs/2834/update primary readmes (#2932)
97d7a39 
* Document the short help-flag of csv export #2834

* Update visualization readme #2834

* Add node version requirements and cli restart order notice

* Finalize instructions, clear up formulations

Co-authored-by: Phanlezz <65733509+phanlezz@users.noreply.github.com>
@phanlezz phanlezz changed the title Update GitHub Pages (CodeCharta Documentation) Update GitHub Pages for Users & READMEs for Developers (CodeCharta Documentation) Nov 16, 2023
This was referenced Dec 8, 2023
Closed
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation priority:high Set by PO
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ce-bo @phanlezz