Add examples to the docs page

[mforets]

This PR brings the examples script (see here) to the main docs page.

I may contribute w/other subsections to that page (example use cases that come up frequently on the issues list of this repo / on Discourse), but we can go in stages.. :)

[mforets]

This PR is only an update to the docs. As you may know, Documenter has a feature to push a preview of the docs if you set push_preview=true in the call to deploydocs. Otherwise, you can pull this forked branch to build the docs locally with:

$ git fetch origin pull/98/head:pr/98 && git checkout pr/98

I always forget that trick :)

[lbenet]

Thanks a lot for your contribution, @mforets!

I left a comment about the wording, which sounds better to me, but be aware that I'm not a native English speaker...

In addition, I'd like to suggest to use push_preview = true within the deploydocs function (in docs/make.jl). It allows to have a preview (online) of the docs; see this for the relevant documentation. (This may make life easier for #99.)

[mforets]

@lbenet I've updated this branch with master, however i'm not sure if docs preview will work because the PR is made from my fork (I don't have rights to make it from JuliaIntervals).

[lbenet]

Thanks a lot; I'll take a look on them later...

I think you need to rebase to master (and push again), since #100 has been merged. this should make possible to see the preview of the docs.

[mforets]

I think you need to rebase to master (and push again), since #100 has been merged. this should make possible to see the preview of the docs.

yes, i did just that. about my comment on the fork is about this Note:

Pull requests made from forks will not have previews. Hosting previews requires access to the deploy key. Therefore, previews are available only for pull requests that were submitted directly from the main repository.

[lbenet]

Mmmm... you are right. Since the proposed changes LGTM, I guess we can simply go ahead and merge them. Is this ready?

[mforets]

from my side it is ready 👌

[lbenet]

Thanks a lot @mforets!! Merging.