Automatically test documentation examples

[almet]

On previous services, we were using HTTPie to provide examples in the documentation of the service.

On python, we use to have docstrings which are executable, and we could check if the doc was valid with the library we're creating.

I believe we can accomplish something similar here for the readinglist, with HTTPie examples tested automatically. We could even integrate that as a new target of or CI.

That would help us to be sure our documentation is up to date with the latest code.

What do you think?

[leplatrem]

Yes, why not

This reminds me https://github.com/jeromeetienne/jsdoced.js

[n1k0]

Great idea. Dealing with auth might make things a little harder, but I love the idea.