Skip to content

Commit 02b66a6

Browse files
authored
revised documentation for v1.1.6
Updated documentation(compare menu)
2 parents 5b0f34e + b6cf91a commit 02b66a6

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

DOCUMENTATION.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ or use `pm2` by downloading it from npm - `npm i -g pm2` and start the module by
6666
### Left Pane Menu
6767

6868
- **Repositories** - To check tracked files changes, line-based changes with syntax highlighting and git operations (staging, un-staging, committing changes and pushing changed to remote)
69+
- **Compare** - To compare the branches and commits for the selected repository.
6970
- **Settings** - To check and edit internal data file, to remove a repo from GitConvex and to update the active port.
7071
- **Help** - Includes documentation link and various options to report an issue or to submit feedback.
7172

@@ -143,6 +144,17 @@ In "Git Difference" click on the modified file to see the difference. The platfo
143144

144145
![git-difference](https://user-images.githubusercontent.com/65342122/89559704-ab793300-d833-11ea-88a8-28afea4b461b.png)
145146

147+
## Compare
148+
- The **Compare** menu has two sections: **Branch compare** and **Commit compare**.
149+
150+
- **Branch compare** - Compares any two branches based on the selected base branch and compare branch. It displays difference between the selected branches.
151+
152+
![branch-compare](https://user-images.githubusercontent.com/65342122/94800651-83a4e680-0402-11eb-9e34-1c7b53e66add.png)
153+
154+
- **Commit compare** - Compares any two commits based on the selected base commit and compare commit. It shows file difference between the selected commits.
155+
156+
![commit-compare](https://user-images.githubusercontent.com/65342122/94800717-9d462e00-0402-11eb-84aa-9890bfea1f78.png)
157+
146158
## Settings
147159
- Settings in the left pane has three sections (Server data file, saved repos, Active GitConvex port number).
148160
![settings](https://user-images.githubusercontent.com/65342122/87243003-a4871c80-c44f-11ea-9d1a-8350bdfb0da8.png)
@@ -157,4 +169,4 @@ In "Git Difference" click on the modified file to see the difference. The platfo
157169
## Help and Support
158170

159171
- Visit help section if you're facing an issue or need any help. If you have any queries or feedback, then discuss it in "Discord" or report an issue in GitHub.
160-
![help-and-support](https://user-images.githubusercontent.com/65342122/87242999-8f11f280-c44f-11ea-9a81-f6cde7b4b419.png)
172+
![help-and-support](https://user-images.githubusercontent.com/65342122/94940199-d2c94500-04f0-11eb-9212-16c57d642c61.png)

0 commit comments

Comments
 (0)