Skip to content

Commit 84dff52

Browse files
committed
Tweaks docs
1 parent 54f5619 commit 84dff52

File tree

5 files changed

+24
-25
lines changed

5 files changed

+24
-25
lines changed

CHANGELOG.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,15 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
88

99
### Added
1010

11-
- Adds [**Commit Graph**](https://github.com/gitkraken/vscode-gitlens#commit-graph-view-)
12-
- The Commit Graph helps you easily visualize branch structure and commit history. Not only does it help you verify your changes, but also easily see changes made by others and when.
13-
![Commit Graph illustration](https://raw.githubusercontent.com/gitkraken/vscode-gitlens/main/images/docs/commit-graph-illustrated.png)
14-
- Adds [**rich integration**](https://github.com/gitkraken/vscode-gitlens#remote-provider-integrations-) with GitHub Enterprise — closes [#1210](https://github.com/gitkraken/vscode-gitlens/issues/1210)
11+
- ✨ Adds an all-new [**Commit Graph**](https://github.com/gitkraken/vscode-gitlens#commit-graph-), a [GitLens+ feature](https://gitkraken.com/gitlens/plus-features) — helps you to easily visualize branch structure and commit history. Not only does it help you verify your changes, but also easily see changes made by others and when
12+
![Commit Graph illustration](https://raw.githubusercontent.com/gitkraken/vscode-gitlens/main/images/docs/commit-graph-illustrated.png)
13+
- Adds a [**Commit Details view**](https://github.com/gitkraken/vscode-gitlens#commit-details-view-) — provides rich details for commits and stashes
14+
- Contextually updates as you navigate:
15+
- lines in the text editor
16+
- commits in the _Commit Graph_, _Visual File History_, or _Commits_ view
17+
- stashes in the _Stashes_ view
18+
- Alteratively, you can search for or choose a commit directly from the view
19+
- ✨ Adds [**rich integration**](https://github.com/gitkraken/vscode-gitlens#remote-provider-integrations-) with GitHub Enterprise — closes [#1210](https://github.com/gitkraken/vscode-gitlens/issues/1210)
1520
- Adds associated pull request to line annotations and hovers
1621
![Pull requests on line annotation and hovers](https://raw.githubusercontent.com/gitkraken/vscode-gitlens/main/images/docs/hovers-current-line-details.png)
1722
- Adds associated pull request to status bar blame
@@ -20,13 +25,6 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
2025
- Adds associated pull requests to branches and commits in GitLens views
2126
- Adds rich autolinks for GitHub issues and merge requests, including titles, status, and authors
2227
- Adds rich support to _Autolinked Issues and Pull Requests_ within comparisons to list autolinked GitHub issues and merge requests in commit messages
23-
- Adds [**Commit Details view**](https://github.com/gitkraken/vscode-gitlens#commit-details-view-)
24-
- The Commit Details View provides rich details for commits and stashes.
25-
- These details will contextually update as you navigate:
26-
- lines in the text editor
27-
- commits in the Commit Graph, Visual File History, or Commits view
28-
- stashes in the Stashes view
29-
- Alteratively, search for or choose a commit directly from the view.
3028
- Adds new stash behaviors to use the Source Control (commit message) input box — closes [#2081](https://github.com/gitkraken/vscode-gitlens/issues/2081)
3129
- When a stash is applied or popped and the Source Control input is empty, we will now update the Source Control input to the stash message
3230
- When stashing changes and the Source Control input is not empty, we will now default the stash message input to the Source Control input value
@@ -88,7 +86,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
8886

8987
### Added
9088

91-
- Adds [**rich integration**](https://github.com/gitkraken/vscode-gitlens#remote-provider-integrations-) with GitLab and GitLab self-managed instances — closes [#1236](https://github.com/gitkraken/vscode-gitlens/issues/1236)
89+
- Adds [**rich integration**](https://github.com/gitkraken/vscode-gitlens#remote-provider-integrations-) with GitLab and GitLab self-managed instances — closes [#1236](https://github.com/gitkraken/vscode-gitlens/issues/1236)
9290
- Adds associated pull request to line annotations and hovers
9391
![Pull requests on line annotation and hovers](https://raw.githubusercontent.com/gitkraken/vscode-gitlens/main/images/docs/hovers-current-line-details.png)
9492
- Adds associated pull request to status bar blame

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ Here are just some of the **features** that GitLens provides,
4343
- [**changes**](#file-changes- 'Jump to File Changes') — highlights any local (unpublished) changes or lines changed by the most recent commit
4444
- [**heatmap**](#file-heatmap- 'Jump to File Heatmap') — shows how recently lines were changed, relative to all the other changes in the file and to now (hot vs. cold)
4545
- many rich **Side Bar views**
46+
- a [**_Commit Details_ view**](#commits-details-view- 'Jump to the Commits Details view') to provides rich details for commits and stashes
4647
- a [**_Commits_ view**](#commits-view- 'Jump to the Commits view') to visualize, explore, and manage Git commits
4748
- a [**_Repositories_ view**](#repositories-view- 'Jump to the Repositories view') to visualize, explore, and manage Git repositories
4849
- a [**_File History_ view**](#file-history-view- 'Jump to the File History view') to visualize, navigate, and explore the revision history of the current file or just the selected lines of the current file
@@ -68,7 +69,7 @@ Here are just some of the **features** that GitLens provides,
6869
- user-defined [**modes**](#modes- 'Jump to Modes') for quickly toggling between sets of settings
6970
- and so much more 😁
7071

71-
# Introducing GitLens+ [#](#introducing-gitlens+-features- 'GitLens+ features')
72+
# GitLens+ [#](#gitlens+- 'GitLens+')
7273

7374
GitLens+ adds all-new, completely optional, features that enhance your current GitLens experience when you sign in with a free account. A free GitLens+ account gives you access to these new GitLens+ features on public repos, while a paid account allows you to use them on private repos. Learn more about [GitLens+ features](https://gitkraken.com/gitlens/plus-features?utm_source=gitlens-extension&utm_medium=in-app-links&utm_campaign=gitlens-plus-links).
7475

@@ -78,21 +79,21 @@ GitLens+ adds all-new, completely optional, features that enhance your current G
7879

7980
No, the introduction of GitLens+ has no impact on existing GitLens features, so you won't lose access to any of the GitLens features you know and love. In fact, we are heavily investing in enhancing and expanding the GitLens feature set. Creating an account simply gives you access to a subset of new features that will enable you to get even more out of Git in VS Code!
8081

81-
## Commit Graph view [#](#commit-graph-view- 'Commit Graph view')
82+
## Commit Graph [#](#commit-graph- 'Commit Graph')
8283

8384
<p align="center">
84-
<img src="https://raw.githubusercontent.com/gitkraken/vscode-gitlens/main/images/docs/commit-graph-illustrated.png" alt="Commit Graph view" />
85+
<img src="https://raw.githubusercontent.com/gitkraken/vscode-gitlens/main/images/docs/commit-graph-illustrated.png" alt="Commit Graph" />
8586
</p>
8687

87-
The Commit Graph helps you easily visualize branch structure and commit history. Not only does it help you verify your changes, but also easily see changes made by others and when. Selecting a row within the graph will open in-depth information about a commit or stash in the new [Commit Details view](#commit-details-view-).
88+
The _Commit Graph_ helps you to easily visualize branch structure and commit history. Not only does it help you verify your changes, but also easily see changes made by others and when. Selecting a row within the graph will open in-depth information about a commit or stash in the new [Commit Details view](#commit-details-view-).
8889

8990
## Visual File History view [#](#visual-file-history-view- 'Visual File History view')
9091

9192
<p align="center">
9293
<img src="https://raw.githubusercontent.com/gitkraken/vscode-gitlens/main/images/docs/visual-file-history-illustrated.png" alt="Visual File History view" />
9394
</p>
9495

95-
The Visual File History view allows you to quickly see the evolution of a file, including when changes were made, how large they were, and who made them.
96+
The _Visual File History_ view allows you to quickly see the evolution of a file, including when changes were made, how large they were, and who made them.
9697

9798
Authors who have contributed changes to the file are on the left y-axis to create a swim-lane of their commits over time (the x-axis). Commit are plotted as color-coded (per-author) bubbles, whose size represents the relative magnitude of the changes.
9899

@@ -291,17 +292,17 @@ GitLens adds many side bar views to provide additional rich functionality. The d
291292
<img src="https://raw.githubusercontent.com/gitkraken/vscode-gitlens/main/images/docs/commit-details-view.png" alt="Commits Details view" />
292293
</p>
293294

294-
The Commit Details View provides rich details for commits and stashes: author, commit ID, links to Pull Requests and Issues, autolinks, changed files, and more.
295+
The _Commit Details_ view provides rich details for commits and stashes: author, commit ID, links to Pull Requests and Issues, autolinks, changed files, and more.
295296

296297
These will show contextually as you navigate:
297298

298299
- lines in the text editor
299-
- commits in the [Commit Graph](#commit-graph-view-), [Visual File History](#visual-file-history-view-), or [Commits view](#commits-view-)
300+
- commits in the [Commit Graph](#commit-graph-), [Visual File History](#visual-file-history-view-), or [Commits view](#commits-view-)
300301
- stashes in the [Stashes view](#stashes-view-)
301302

302-
Alteratively, search for or choose a commit directly from the view.
303+
Alteratively, you can search for or choose a commit directly from the view.
303304

304-
**For optimal usage, we highly recommended dragging this view to the secondary sidebar.**
305+
**For optimal usage, we highly recommended dragging this view to the Secondary Side Bar.**
305306

306307
### Commits View [#](#commits-view- 'Commits view')
307308

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11567,7 +11567,7 @@
1156711567
{
1156811568
"id": "gitlens.plus.commitGraph",
1156911569
"title": "Commit Graph (new)",
11570-
"description": "The Commit Graph helps you easily visualize branch structure and commit history.\n\n[Open Commit Graph](command:gitlens.showGraphPage)",
11570+
"description": "The Commit Graph helps you to easily visualize branch structure and commit history.\n\n[Open Commit Graph](command:gitlens.showGraphPage)",
1157111571
"media": {
1157211572
"markdown": "walkthroughs/plus/commit-graph.md"
1157311573
}

src/webviews/apps/home/partials/state.free.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ <h4>Commit Graph</h4>
2929
href="command:gitlens.openWalkthrough?%22gitlens.plus%7Cgitlens.plus.commitGraph%22"
3030
>Commit Graph</a
3131
>
32-
helps you easily visualize branch structure and commit history. Not only does it help you verify your changes,
33-
but also easily see changes made by others and when.
32+
helps you to easily visualize branch structure and commit history. Not only does it help you verify your
33+
changes, but also easily see changes made by others and when.
3434
</p>
3535
<h4>Visual File History</h4>
3636
<img

walkthroughs/plus/commit-graph.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@
44
<img src="../../images/docs/commit-graph-illustrated.png" alt="Commit Graph"/>
55
</p>
66

7-
The Commit Graph helps you easily visualize branch structure and commit history. Not only does it help you verify your changes, but also easily see changes made by others and when. It is freely available for local and public repos, while a paid account is required for use on private repos.
7+
The Commit Graph helps you to easily visualize branch structure and commit history. Not only does it help you verify your changes, but also easily see changes made by others and when. It is freely available for local and public repos, while a paid account is required for use on private repos.

0 commit comments

Comments
 (0)