oxynote/oxynote

解决的问题

Oxynote 解决了“文档漂移”问题，即技术说明、指标图表和 API 文档分散在不同的工具（如 Notion、Grafana 和代码仓库）中，导致它们很快失去同步。它提供了一个统一的工作空间，让实时数据、文档和管理命令共存，确保图表及其上下文始终能够被共同审查和更新。

工作原理

Oxynote 作为一个自托管工作空间，将文档视为一种结构化的、可审查的资产。你可以嵌入“实时指标”块，直接在页面内查询 Prometheus 或 SQL 数据库。对页面的每一次更改都可以通过类似于 pull request 的草稿和审批工作流程进行管理，使团队能够在发布前查看文本、图表和 API 定义的视觉差异。它还包括实时编辑、评论线程和“新鲜度钩子”等协作功能，当底层依赖项发生变化时，会通知维护者。

适用人群

它专为需要记录复杂系统、管理内部 API 和监控基础设施的技术团队而设计。对于那些希望为内部服务获得“Stripe 风格”文档体验，并倾向于为文档采用结构化、类似代码的审查流程的用户来说，它是理想的选择。它不适合作为通用的公司维基，也不适合需要托管云服务的用户。

亮点

• 统一仪表盘： 将实时指标图表、仪表盘和柱状图直接嵌入到说明文本旁边。
• 审查工作流： 使用草稿分支和差异视图来审查文档和系统配置的更改。
• 实时协作： 与团队成员同时编辑页面，并将评论附加到特定的块、图表或文本行。
• 新鲜度跟踪： 自动跟踪 GitHub 文件或容器镜像等依赖项，并在它们过时时接收警报。
• AI 集成： 内置助手，可以使用各种 LLM 提供商或通过 Ollama 使用本地模型来编辑页面并运行查询。