Where to find API documentation [0.5d]
There is no single place to look up documentation for our stack.
This card includes some hints where you can find API documentation. You probably want to drag a few of those links to your bookmarks toolbar. This will help in the upcoming exercises.
Basic classes like
Object are part of the Ruby standard library:
- : Pretty web interface for the Ruby standard library
- : Official docs for the Ruby standard library
Since you will use Rails more than any other gem, you will always want its documentation to be close:
We are so used to having ActiveSupport around that we don’t even think of it separate from Ruby anymore.
Which is why some methods you would expected to be documented in Ruby are actually in the Rails docs, e.g.
README file. Here are a few examples:
Some libraries also publish dedicated sites with their documentation, e.g.:
The German version of MDN is full of incomplete and outdated articles. Only the English version of MDN is actively maintained.
Googling web terms will often rank German MDN articles very high. When you reach a German MDN article that way, the first thing you do is switch to the English version (link on the top right).
When you're using external SaaS APIs, they often publish language-independent documentation. Some examples:
Google is your friend.