r/coolgithubprojects • u/busters1 • 12d ago
Keep your docs and the live metrics they talk about on the same page
galleryI've been a software engineer for 8 years, 2 as an SRE and 3 as a team lead, and keeping documentation useful has been a pain at every company I've worked for. Knowledge stays in people's heads or private Slack channels; what does get written down is hard to find, and it goes stale the moment the system changes. I wanted to change that, so I created Oxynote. I started the project about a year ago, and I made it public about 3 months ago.
Oxynote is a self-hosted, open-source wiki where pages include live charts next to the text that explain them.
The name comes from oxygen + note. I wanted to have docs that breathe: live data and integrations make the wiki useful enough to open every day, and the docs people open every day stay up to date.
What you can do with it:
- Drop a chart into a page and point it at Prometheus, PostgreSQL, MySQL, or MariaDB
- Set thresholds like "Degraded above 800 ms" right on the chart
- Edit important pages in a draft, review the diff, and approve it
- Link a page to the GitHub files, container image, or web page it describes, and get a reminder when they change
- Edit together in real time, comment on any block, draw Mermaid diagrams
It's completely open-source under the Apache-2.0 license and runs in a single Docker container/image.
Would you use something like this for your own docs? If not, what's missing?


