docs: add docs for the new api.

Typo: ``What this means is that is you visit``, the second *is* should be *if*.