oxynote/oxynote

What it solves

Oxynote solves the problem of "documentation drift," where technical explanations, metric charts, and API documentation live in separate tools (like Notion, Grafana, and code repositories) and quickly fall out of sync. It provides a unified workspace where live data, documentation, and administrative commands coexist, ensuring that charts and their context are always reviewed and updated together.

How it works

Oxynote functions as a self-hosted workspace that treats documentation as a structured, reviewable asset. You can embed "Live Metrics" blocks that query Prometheus or SQL databases directly within a page. Every change to a page can be managed through a draft-and-approval workflow similar to a pull request, allowing teams to see visual diffs of text, charts, and API definitions before they are published. It also includes collaboration features like real-time editing, comment threads, and "freshness hooks" that notify maintainers when underlying dependencies change.

Who it’s for

It is designed for technical teams who need to document complex systems, manage internal APIs, and monitor infrastructure. It is ideal for those who want a "Stripe-style" documentation experience for internal services and prefer a structured, code-like review process for their documentation. It is not intended as a general-purpose company wiki or for users who require a managed, cloud-hosted service.

Highlights

• Unified Dashboards: Embed live metric charts, gauges, and bar charts directly alongside explanatory text.
• Review Workflows: Use draft branches and diff views to review changes to documentation and system configurations.
• Real-time Collaboration: Edit pages simultaneously with team members and attach comments to specific blocks, diagrams, or lines of text.
• Freshness Tracking: Automatically track dependencies like GitHub files or container images and receive alerts when they become outdated.
• AI Integration: Includes a built-in assistant that can edit pages and run queries using various LLM providers or local models via Ollama.