Boost logo

Boost :

Subject: [boost] Boost documentation with ability for users to post comments
From: Krzysztof Jusiak (krzysztof_at_[hidden])
Date: 2015-06-05 13:13:21


Hi,

Recently I come across presentation from CppCon 2015 (Boost 2.0 by Robert
Ramey).
One of the points mentioned was related to adding possibility to allow
users to post comments on the documentation pages.

I have recently added such functionality to Boost.DI documentation using
https://disqus.com service.
It allows you to have comments on each page.

It's also really easy to do add it to qbk based documentation:
    1. Create an account on disqus service and add your website (consider
allowing anonymous posts in settings)
    2. Generate html doc using boost quickbook as usual
    3. Add comments with simple script:
           find html -iname "*.html" | xargs sed -i -e '/<\/body>/{r
comments.html' -e 'd}' -e 's/<\/html>/<\/body><\/html>/'
        where comments.html content is taken from disqus service ->
https://github.com/krzysztof-jusiak/di/blob/cpp14/doc/comments.html
    4. Deploy and enjoy users being able to add/read comments.... (on the
bottom of each page)

That's all, you can try it out and post, preferably useful feedback, on
Boost.DI documentation website:
http://krzysztof-jusiak.github.io/di/cpp14/boost/libs/di/doc/html/

Cheers, Kris


Boost list run by bdawes at acm.org, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk