We started to set up our documentation (and migrate our existing one) using these principles: https://documentation.divio.com/
We really like the 4 ways of documentation serving different purposes and functions.
a
Adam Buggia
08/08/2022, 6:00 PM
This is really useful, thanks.
l
Laszlo Fogas
08/09/2022, 8:07 PM
Yeah this division also helped e immensly recently
"Should I explains stuff, should I explain everything? No this is a tutorial, just need to get people from 0 to something meaningful.. no need to explain."
r
Rohan Gupta
09/08/2022, 2:31 PM
@Johannes Witte@Adam Buggiahttps://docs.sourcegraph.com/notebooks - Inspired by Jupyter Notebooks and powered by Markdown and Sourcegraph’s code search, Notebooks let you and your team create living documentation that interacts directly with your code. You can leverage Notebooks to onboard a new teammate, document known vulnerabilities, a common pattern in your codebase, or useful Sourcegraph queries.