oxynote/oxynote

해결하는 문제

Oxynote는 기술 설명, 메트릭 차트, API 문서가 서로 다른 도구(Notion, Grafana, 코드 저장소 등)에 분산되어 빠르게 동기화가 어긋나는 '문서 드리프트' 문제를 해결합니다. 실시간 데이터, 문서, 관리 명령이 공존하는 통합 작업 공간을 제공하여 차트와 그 맥락이 항상 함께 검토되고 업데이트되도록 보장합니다.

작동 방식

Oxynote는 문서를 구조화되고 검토 가능한 자산으로 취급하는 셀프 호스팅 작업 공간으로 작동합니다. 페이지 내에 Prometheus나 SQL 데이터베이스를 직접 쿼리하는 '실시간 메트릭' 블록을 삽입할 수 있습니다. 페이지에 대한 모든 변경 사항은 pull request와 유사한 초안 및 승인 워크플로우를 통해 관리되며, 팀은 게시하기 전에 텍스트, 차트, API 정의의 시각적 차이를 확인할 수 있습니다. 또한 실시간 편집, 댓글 스레드, 기본 종속성이 변경될 때 유지 관리자에게 알리는 '신선도 후크'와 같은 협업 기능도 포함되어 있습니다.

대상 사용자

복잡한 시스템을 문서화하고, 내부 API를 관리하며, 인프라를 모니터링해야 하는 기술 팀을 위해 설계되었습니다. 내부 서비스를 위한 'Stripe 스타일'의 문서 경험을 원하고 문서에 대해 구조화된 코드와 같은 검토 프로세스를 선호하는 사용자에게 이상적입니다. 범용 회사 위키나 관리형 클라우드 호스팅 서비스가 필요한 사용자를 위한 것은 아닙니다.

주요 특징

• 통합 대시보드: 실시간 메트릭 차트, 게이지, 막대 차트를 설명 텍스트와 함께 직접 삽입할 수 있습니다.
• 검토 워크플로우: 초안 브랜치와 차이점 보기를 사용하여 문서 및 시스템 구성 변경 사항을 검토할 수 있습니다.
• 실시간 협업: 팀원과 동시에 페이지를 편집하고 특정 블록, 다이어그램 또는 텍스트 줄에 댓글을 달 수 있습니다.
• 신선도 추적: GitHub 파일이나 컨테이너 이미지와 같은 종속성을 자동으로 추적하고 오래되었을 때 알림을 받을 수 있습니다.
• AI 통합: 다양한 LLM 제공업체나 Ollama를 통한 로컬 모델을 사용하여 페이지를 편집하고 쿼리를 실행할 수 있는 내장 어시스턴트가 포함되어 있습니다.