holoviz-dev / nbsite

Build a tested, sphinx-based website from notebooks
https://nbsite.holoviz.org
BSD 3-Clause "New" or "Revised" License
28 stars 13 forks source link

Feature: add link to and/or summary of related issues/Q&A to doc pages #165

Open ceball opened 4 years ago

ceball commented 4 years ago

This might be a bit ambitious, or out of scope for nbsite, or already possible via some other tool (I don't know)...

While trying to contribute to a project that uses azure pipelines, I have been consulting the azure docs. Typically, I am unable to understand any of the doc pages (each page assumes you have already read all the others including the page you are currently reading, plus that you already know how to do what you are tying to do...), but what's great is that each page has a "feedback" section at the bottom:

Screenshot from 2020-03-06 13-12-47

Those questions and answers end up being what I actually use to figure out what I'm trying to do.

Also, reading the docs often prompts questions, so it's quite nice to be able to see if someone else asked your question (meaning you can then get an immediate answer), or to be able to ask it right away as it's in your mind.

Not sure what we'd link to, or how we'd do it...