-
Notifications
You must be signed in to change notification settings - Fork 1.3k
CSHARP-5843: Update README file with the link to redirect to the latest api docs #1854
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.
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR updates the documentation link in the README to point to the latest API documentation instead of a specific version (3.4.0), and removes a trailing slash from a GitHub API URL.
Changes:
- Updated README documentation badge to use
/latest.htmlinstead of/3.4.0/api/index.html - Removed trailing slash from GitHub releases API URL endpoint
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Updates documentation link to point to latest version instead of hardcoded 3.4.0 |
| evergreen/release-notes.py | Removes trailing slash from GitHub API releases endpoint URL |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| raise SystemExit("Release with the tag already exists") | ||
|
|
||
| url = '{github_api_base_url}{repo}/releases/'.format(github_api_base_url=opts.github_api_base_url, repo=opts.repo) | ||
| url = '{github_api_base_url}{repo}/releases'.format(github_api_base_url=opts.github_api_base_url, repo=opts.repo) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Trailing slash in the URL made GitHub Rest API to throw 404 error.
|
|
||
| [](https://www.nuget.org/packages/MongoDB.Driver/) | ||
| [](https://mongodb.github.io/mongo-csharp-driver/3.4.0/api/index.html) | ||
| [](https://mongodb.github.io/mongo-csharp-driver/latest.html) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This new page is being generated as a part of the release (new in 3.6 release). The static page will be updated on each release to point to the latest released API docs.
papafe
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
No description provided.