Skip to content

Commit e509b54

Browse files
authored
docs: Update README docs links (#946)
Update README docs links to point at release branch. The goal of this change is to avoid confusing users when we merge major changes (e.g. the executable rename, the dotnet tool install option, etc.) to main but have not yet released them. With this update, the documentation should align with the latest release.
2 parents 452981c + e710dfd commit e509b54

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ GCM replaces both the .NET Framework-based
2222

2323
## Install
2424

25-
See [installation instructions][install] for your operating system.
25+
See the [installation instructions][install] for the current version of GCM for
26+
install options for your operating system.
2627

2728
## Current status
2829

@@ -119,24 +120,24 @@ When using GitHub logos, please be sure to follow the
119120
[bitbucket]: https://bitbucket.org
120121
[bitbucket-ssh]: https://confluence.atlassian.com/bitbucket/ssh-keys-935365775.html
121122
[build-status-badge]: https://github.com/GitCredentialManager/git-credential-manager/actions/workflows/continuous-integration.yml/badge.svg
122-
[docs-index]: docs/README.md
123+
[docs-index]: https://github.com/GitCredentialManager/git-credential-manager/blob/release/docs/README.md
123124
[dotnet]: https://dotnet.microsoft.com
124125
[git-credential-helper]: https://git-scm.com/docs/gitcredentials
125126
[gcm]: https://github.com/GitCredentialManager/git-credential-manager
126127
[gcm-coc]: CODE_OF_CONDUCT.md
127128
[gcm-commit-12294990]: https://github.com/git/git/commit/12294990c90e043862be9eb7eb22c3784b526340
128129
[gcm-contributing]: CONTRIBUTING.md
129-
[gcm-credstores]: docs/credstores.md
130+
[gcm-credstores]: https://github.com/GitCredentialManager/git-credential-manager/blob/release/docs/credstores.md
130131
[gcm-for-mac-and-linux]: https://github.com/microsoft/Git-Credential-Manager-for-Mac-and-Linux
131132
[gcm-for-windows]: https://github.com/microsoft/Git-Credential-Manager-for-Windows
132-
[gcm-http-proxy]: docs/netconfig.md#http-proxy
133+
[gcm-http-proxy]: https://github.com/GitCredentialManager/git-credential-manager/blob/release/docs/netconfig.md#http-proxy
133134
[gcm-license]: LICENSE
134-
[gcm-usage]: docs/usage.md
135-
[gcm-windows-broker]: docs/windows-broker.md
135+
[gcm-usage]: https://github.com/GitCredentialManager/git-credential-manager/blob/release/docs/usage.md
136+
[gcm-windows-broker]: https://github.com/GitCredentialManager/git-credential-manager/blob/release/docs/windows-broker.md
136137
[git-tools-credential-storage]: https://git-scm.com/book/en/v2/Git-Tools-Credential-Storage
137138
[github]: https://github.com
138139
[github-ssh]: https://help.github.com/en/articles/connecting-to-github-with-ssh
139140
[github-logos]: https://github.com/logos
140-
[install]: docs/install.md
141+
[install]: https://github.com/GitCredentialManager/git-credential-manager/blob/release/docs/install.md
141142
[ms-package-repos]: https://packages.microsoft.com/repos/
142143
[workflow-status]: https://github.com/GitCredentialManager/git-credential-manager/actions/workflows/continuous-integration.yml

0 commit comments

Comments
 (0)