README improvements: updated links, fixed typos, improved phrasing - Githubissues

QuantConnect / Documentation

QuantConnect Wiki Style Documentation Behind QuantConnect

https://www.quantconnect.com/docs/v2/

Apache License 2.0

173 stars 139 forks source link

README improvements: updated links, fixed typos, improved phrasing #1818

Closed logkirk closed 4 months ago

logkirk commented 4 months ago

Description

Removed Mailing List section from README since the mailing list no longer exists. See discussion on Discord and dead Google Group.
Fixed typos and updated phrasing for increased clarity.
Reordered links. Updated broken links and improved phrasing. Added mailto link.

Related Issue

Fixes #1817

Motivation and Context

Some links in README are outdated. There are some typos, and some phrasing could be improved for better clarity.

Types of changes

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] Refactor (non-breaking change which improves implementation)
[ ] New feature (non-breaking change which adds functionality)
[x] Non-functional change (xml comments/documentation/etc)

Checklist:

[x] My code follows the code style of this project.
[x] I have read the CONTRIBUTING document.
[x] My branch follows the naming convention bug-<issue#>-<description> or feature-<issue#>-<description>