Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.Sign up
Use the official docs for external docs, not the marketing page #12
Very tiny simple PR, that I thought might be useful to totally separate from the other massive one.
Note that both now and with this change, these URLs aren't correct for all services. There doesn't seem to be a system, e.g.:
This works for most of them though, especially the popular cases. Might be nice to improve in future, ok for now imo.
They don't very clearly point to the docs though, it's a bit of a hunt. There's no one clear link, and the route from each is different. From https://aws.amazon.com/rds, you can go Resources, then Amazon AWS Documentation, and then you get most of the same content. For https://aws.amazon.com/ec2/ it's Resources -> Developer Resources -> Documentation. It's all just a bit more awkward, and not very convenient.
Agree it's a bit subjective, but the specs do specifically say this should link to documentation, and that does seem to be the convention everywhere else. E.g. the Slack spec links to https://api.slack.com/web, not https://slack.com, and the Github spec links to https://developer.github.com/v3/.