gh-4 : convert ascii drawning to mermaid - both graph and gitgraph #5
Conversation
WalkthroughThe diff introduces visual representations using Mermaid for Git history and workflow, illustrating a non-linear commit history structure and workflow branches. This addition enhances the visual storytelling of version control processes for better understanding. Changes
Recent Review DetailsConfiguration used: CodeRabbit UI Files selected for processing (1)
Additional Context UsedLanguageTool (49)
Additional comments not posted (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Out of diff range and nitpick comments (7)
README.md (7)
Line range hint
3-3: Correct the spelling of "rational" to "rationale".- ## The rational for storing artifacts in git + ## The rationale for storing artifacts in git
Line range hint
4-4: Correct the spelling of "embbeded" to "embedded".- I have, over the years in the embbeded enterprise industry, constantly come across many scenarios where zipping, downloading and unzipping generic dependencies and maintaining workspace + I have, over the years in the embedded enterprise industry, constantly come across many scenarios where zipping, downloading and unzipping generic dependencies and maintaining workspace
Line range hint
5-5: Correct the phrase "it self" to "itself".- Git is a fantastic zipper it self and you get integrity of workspaces for free. + Git is a fantastic zipper itself and you get integrity of workspaces for free.
Line range hint
7-7: Correct the spelling of "block chain" to "blockchain", "distrubuted" to "distributed", and "horisontally" to "horizontally".- Git has always been mentioned to be bad for storing artifacts due to the block chain technology and distrubuted architecture. Git-artifact make sure this problem is handled by storing commits "horisontally" using tags rather than the default "stacked" way. + Git has always been mentioned to be bad for storing artifacts due to the blockchain technology and distributed architecture. Git-artifact make sure this problem is handled by storing commits "horizontally" using tags rather than the default "stacked" way.
Line range hint
8-8: Correct the spelling of "intermidiate" to "intermediate".- Firstly; You can garbage collect intermidiate artifacts by just deleting the tag + Firstly; You can garbage collect intermediate artifacts by just deleting the tag
Line range hint
15-15: Correct the spelling of "maintainance" to "maintenance" and "coqnative" to "cognitive".- You can save additional license and maintainance cost and/or coqnative load by maintaining and using an additional system for artifacts. + You can save additional license and maintenance cost and/or cognitive load by maintaining and using an additional system for artifacts.
Line range hint
28-28: Correct the spelling of "favorit" to "favorite".- Use your favorit git dependency system like submodules(this is the correct way for submodule usage btw ), repo tool or .. + Use your favorite git dependency system like submodules(this is the correct way for submodule usage btw ), repo tool or ..
There was a problem hiding this comment.
Actionable comments posted: 0
Out of diff range and nitpick comments (11)
README.md (11)
Line range hint
3-3: Correct the spelling of "rational" to "rationale".- ## The rational for storing artifacts in git + ## The rationale for storing artifacts in git
Line range hint
4-4: Correct the spelling of "embbeded" to "embedded".- I have, over the years in the embbeded enterprise industry, constantly come across many scenarios where zipping, downloading and unzipping generic dependencies and maintaining workspace + I have, over the years in the embedded enterprise industry, constantly come across many scenarios where zipping, downloading and unzipping generic dependencies and maintaining workspace
Line range hint
5-5: Change "it self" to "itself".- Git is a fantastic zipper it self and you get integrity of workspaces for free. + Git is a fantastic zipper itself and you get integrity of workspaces for free.
Line range hint
7-7: Correct the spelling of "block chain" to "blockchain" and "distrubuted" to "distributed".- Git has always been mentioned to be bad for storing artifacts due to the block chain technology and distrubuted architecture. + Git has always been mentioned to be bad for storing artifacts due to the blockchain technology and distributed architecture.
Line range hint
7-7: Correct the spelling of "horisontally" to "horizontally".- Git-artifact make sure this problem is handled by storing commits "horisontally" using tags rather than the default "stacked" way. + Git-artifact make sure this problem is handled by storing commits "horizontally" using tags rather than the default "stacked" way.
Line range hint
8-8: Correct the spelling of "intermidiate" to "intermediate".- Firstly; You can garbage collect intermidiate artifacts by just deleting the tag + Firstly; You can garbage collect intermediate artifacts by just deleting the tag
Line range hint
15-15: Correct the spelling of "maintainance" to "maintenance" and "coqnative" to "cognitive".- You can save additional license and maintainance cost and/or coqnative load by maintaining and using an additional system for artifacts. + You can save additional license and maintenance cost and/or cognitive load by maintaining and using an additional system for artifacts.
Line range hint
28-28: Correct the spelling of "favorit" to "favorite".- Use your favorit git dependency system like submodules(this is the correct way for submodule usage btw ), repo tool or .. + Use your favorite git dependency system like submodules(this is the correct way for submodule usage btw ), repo tool or ..
Line range hint
80-80: Correct the spelling of "constumer" to "consumer".- The repository and path initialize above ready to use. Copy the artifacts to your path in the folder structure the "constumer" desire it. + The repository and path initialize above ready to use. Copy the artifacts to your path in the folder structure the "consumer" desire it.
Line range hint
87-87: Correct the spelling of "commited" to "committed".- The artifact v1.0 is now commited, pushed _and_ importantly - the workspace is set back to the default branch of the remote repository. + The artifact v1.0 is now committed, pushed _and_ importantly - the workspace is set back to the default branch of the remote repository.
Line range hint
120-120: Correct the spelling of "accessable" to "accessible".- You can make it easy accessable by adding the source code as submodule and sha1 in to the artifact history. + You can make it easy accessible by adding the source code as submodule and sha1 in to the artifact history.
%%{init: {
'gitGraph': {
'loglevel' : 'debug',
'orientation': 'vertical',
'showCommitLabel': true,
'showBranches': false
}} }%%
gitGraph:
commit id: "init" tag: "init" type: HIGHLIGHT
branch latest-1.0 order: 2
branch latest-1.1 order: 3
branch latest-1.2 order: 4
branch latest-2.0 order: 5
checkout latest-1.0
commit id: "1.0/bin" tag: "1.0/bin"
commit id: "1.0/src" tag: "1.0/src"
checkout latest-1.1
commit id: "1.1/bin" tag: "1.1"
checkout latest-1.2
commit id: "1.2/bin" tag: "1.2"
checkout latest-2.0
commit id: "2.0/bin" tag: "2.0"
checkout main
commit id: "update scripts" tag: "main" type: HIGHLIGHT
branch foo order: 1
checkout foo
commit id: "3.0/bin" tag: "3.0/bin"
checkout latest-1.0
commit id: "2.0/test" tag: "2.0/test"
|
There was a problem hiding this comment.
Actionable comments posted: 4
Out of diff range and nitpick comments (6)
README.md (6)
Line range hint
3-3: Correct the spelling of "rational" to "rationale".- ## The rational for storing artifacts in git + ## The rationale for storing artifacts in git
Line range hint
15-15: Correct the spelling of "maintainance" to "maintenance" and "coqnative" to "cognitive".- You can save additional license and maintainance cost and/or coqnative load by maintaining and using an additional system for artifacts. + You can save additional license and maintenance cost and/or cognitive load by maintaining and using an additional system for artifacts.
Line range hint
28-28: Correct the spelling of "favorit" to "favorite".- Use your favorit git dependency system like submodules(this is the correct way for submodule usage btw ), repo tool or .. + Use your favorite git dependency system like submodules(this is the correct way for submodule usage btw ), repo tool or ..
Line range hint
90-90: Correct the spelling of "constumer" to "consumer".- The repository and path initialize above ready to use. Copy the artifacts to your path in the folder structure the "constumer" desire it. + The repository and path initialize above ready to use. Copy the artifacts to your path in the folder structure the "consumer" desire it.
Line range hint
130-130: Correct the spelling of "accessable" to "accessible".- You can make it easy accessable by adding the source code as submodule and sha1 in to the artifact history. + You can make it easy accessible by adding the source code as submodule and sha1 in to the artifact history.
Line range hint
156-156: Correct the spelling of "managemnet" to "management" and "reposity" to "repository".- This way is like promotion in normal artifact managemnet systems, where you promote to from one project/repository to another. + This way is like promotion in normal artifact management systems, where you promote from one project/repository to another.
| @@ -4,7 +4,7 @@ | |||
| I have, over the years in the embbeded enterprise industry, constantly come across many scenarios where zipping, downloading and unzipping generic dependencies and maintaining workspace | |||
There was a problem hiding this comment.
Correct the spelling of "embbeded" to "embedded".
- I have, over the years in the embbeded enterprise industry, constantly come across many scenarios where zipping, downloading and unzipping generic dependencies and maintaining workspace
+ I have, over the years in the embedded enterprise industry, constantly come across many scenarios where zipping, downloading and unzipping generic dependencies and maintaining workspaceCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| I have, over the years in the embbeded enterprise industry, constantly come across many scenarios where zipping, downloading and unzipping generic dependencies and maintaining workspace | |
| I have, over the years in the embedded enterprise industry, constantly come across many scenarios where zipping, downloading and unzipping generic dependencies and maintaining workspace |
| @@ -4,7 +4,7 @@ | |||
| I have, over the years in the embbeded enterprise industry, constantly come across many scenarios where zipping, downloading and unzipping generic dependencies and maintaining workspace | |||
| has slowed down turn around time for developers and CI system. Git is a fantastic zipper it self and you get integrity of workspaces for free. | |||
There was a problem hiding this comment.
Correct the phrase "it self" to "itself".
- Git is a fantastic zipper it self and you get integrity of workspaces for free.
+ Git is a fantastic zipper itself and you get integrity of workspaces for free.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| has slowed down turn around time for developers and CI system. Git is a fantastic zipper it self and you get integrity of workspaces for free. | |
| has slowed down turn around time for developers and CI system. Git is a fantastic zipper itself and you get integrity of workspaces for free. |
| @@ -4,7 +4,7 @@ | |||
| I have, over the years in the embbeded enterprise industry, constantly come across many scenarios where zipping, downloading and unzipping generic dependencies and maintaining workspace | |||
| has slowed down turn around time for developers and CI system. Git is a fantastic zipper it self and you get integrity of workspaces for free. | |||
|
|
|||
| Git has always been mentioned to be bad for storing artifacts due to the block chain technology and distrubuted architecture. Git-artifact make sure this problem is handled by storing commits "horisontally" using tags rather than the default "stacked" way. It gives a few advantages compared to standard usage of git: | |||
| Git has always been mentioned to be bad for storing artifacts due to the block chain technology and distrubuted architecture. `git-artifact` make sure this problem is handled by storing commits "horisontally" using tags rather than the default "stacked" way. It gives a few advantages compared to standard usage of git: | |||
There was a problem hiding this comment.
Correct the spelling of "block chain" to "blockchain", "distrubuted" to "distributed", and "horisontally" to "horizontally".
- Git has always been mentioned to be bad for storing artifacts due to the block chain technology and distrubuted architecture. `git-artifact` make sure this problem is handled by storing commits "horisontally" using tags rather than the default "stacked" way.
+ Git has always been mentioned to be bad for storing artifacts due to the blockchain technology and distributed architecture. `git-artifact` make sure this problem is handled by storing commits "horizontally" using tags rather than the default "stacked" way.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| Git has always been mentioned to be bad for storing artifacts due to the block chain technology and distrubuted architecture. `git-artifact` make sure this problem is handled by storing commits "horisontally" using tags rather than the default "stacked" way. It gives a few advantages compared to standard usage of git: | |
| Git has always been mentioned to be bad for storing artifacts due to the blockchain technology and distributed architecture. `git-artifact` make sure this problem is handled by storing commits "horizontally" using tags rather than the default "stacked" way. It gives a few advantages compared to standard usage of git: |
| @@ -4,7 +4,7 @@ | |||
| I have, over the years in the embbeded enterprise industry, constantly come across many scenarios where zipping, downloading and unzipping generic dependencies and maintaining workspace | |||
| has slowed down turn around time for developers and CI system. Git is a fantastic zipper it self and you get integrity of workspaces for free. | |||
|
|
|||
| Git has always been mentioned to be bad for storing artifacts due to the block chain technology and distrubuted architecture. Git-artifact make sure this problem is handled by storing commits "horisontally" using tags rather than the default "stacked" way. It gives a few advantages compared to standard usage of git: | |||
| Git has always been mentioned to be bad for storing artifacts due to the block chain technology and distrubuted architecture. `git-artifact` make sure this problem is handled by storing commits "horisontally" using tags rather than the default "stacked" way. It gives a few advantages compared to standard usage of git: | |||
| - Firstly; You can garbage collect intermidiate artifacts by just deleting the tag | |||
There was a problem hiding this comment.
Correct the spelling of "intermidiate" to "intermediate".
- Firstly; You can garbage collect intermidiate artifacts by just deleting the tag
+ Firstly; You can garbage collect intermediate artifacts by just deleting the tagCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| - Firstly; You can garbage collect intermidiate artifacts by just deleting the tag | |
| Firstly; You can garbage collect intermediate artifacts by just deleting the tag |
Summary by CodeRabbit