docs: simple page that lists the entire API

[gurpreetatwal]

I wasn't able to find document that lists/links to the library's complete API on a single page. The current docs are great for a quick getting started tutorial but aren't as helpful when you're using the library in a project already and don't remember the name or maybe the signature of one of the functions.

As an example, Sinon has this page.

[searls]

this is a good idea and overdue 👍

[gurpreetatwal]

I can start working on this if you want; however I just started using the library yesterday 😜

I was thinking of just adding a API.md to the docs folder, or maybe a wiki page?

[searls]

Since we haven't been using wiki yet it's probably not right to start now. I think an docs/api.md makes plenty of sense as a reference point, however, even if most of what it does is list out every top-level method and just link back to the workflow-organized markdown pages elsewhere

[gurpreetatwal]

Yeah I agree, the doc could have a "table of contents" which has the entire API and then each method in the doc would link to a section in the main docs.

Something like:

---

API

...

• td.replace

....

Methods

...

td.replace(object, propertyName, [manualReplacement]) ⇒ fake

short description and link back to main docs
...

[searls]

yes, exactly

[gurpreetatwal]

Sounds good! I'll get started on this later today

[searls]

This is done if you look at the recently rewritten README.md