Moxie Docs

Moxie Docs란?

Moxie Docs는 GitHub 저장소를 위한 문서 시스템으로, 코드베이스 문서를 자동으로 생성하고 유지합니다. 저장소를 인덱싱하고, 아키텍처, 규칙, 워크스루에 대한 검색 가능한 문서를 만들며, 코드가 변경되면 해당 페이지를 다시 확인해 오래된 내용을 표시하고 다시 작성할 수 있게 합니다.

또한 MCP를 통해 저장소 규칙과 검증된 컨텍스트를 AI 도구에 제공하며, 작업 범위에 한정된 읽기 전용 접근을 지원합니다. 더불어 주간 docs-only “Friday Cleanup” 풀 리퀘스트를 열어 한 주 동안 쌓인 드리프트를 모아 정리할 수도 있습니다.

주요 기능

• 지속적인 저장소 인덱싱: Moxie는 GitHub 저장소에 연결해 머지가 발생할 때마다 인덱스를 최신 상태로 유지하므로, 문서가 최신 코드와 연결됩니다.
• 출처가 표시된 생성 문서: 아키텍처 페이지, 규칙, 워크스루를 생성하고 원본 코드로 되돌아가는 인용을 포함해, 결과를 더 쉽게 검증할 수 있게 합니다.
• 머지 시 드리프트 감지: 코드 변경이 기존 문서에 영향을 주면 Moxie가 드리프트를 표시하고 관련 페이지를 오래된 상태로 두지 않고 다시 생성합니다.
• 에이전트를 위한 MCP 컨텍스트: Cursor, Claude Code, Codex 같은 AI 도구가 매 프롬프트마다 저장소를 다시 크롤링하지 않고도 MCP를 통해 규칙, 문서, 검증된 명령을 가져올 수 있습니다.
• Friday Cleanup PR: Moxie는 주 1회 docs-only 풀 리퀘스트를 열어 검토할 문서 업데이트를 모아 제시할 수 있습니다.
• PR 워크플로 검사: 팀이 코드 변경과 머지 제어를 유지하는 동안, 머지 전에 풀 리퀘스트의 문서 영향과 설명 일치 여부를 확인할 수 있습니다.

Moxie Docs 사용 방법

먼저 GitHub 저장소를 연결합니다. Moxie가 코드베이스를 인덱싱하고, 첫 문서 세트를 생성하며, 사람이든 AI 에이전트든 재사용할 수 있는 규칙을 요약합니다.

그 다음 팀은 주로 두 가지 방식으로 사용합니다. Moxie가 생성하고 업데이트한 문서를 검토하고, 새 풀 리퀘스트에서 오래된 문서나 설명 불일치가 있는지 확인하게 합니다. 원한다면 MCP 통합을 사용해 코딩 에이전트가 저장소별 컨텍스트를 범위가 제한된 읽기 전용 방식으로 가져올 수도 있습니다.

사용 사례

• 아키텍처 문서를 최신 상태로 유지: 팀이 웹훅 동작이나 결제 흐름 같은 페이지를 관리하면, 관련 코드 변경이 반영될 때 Moxie가 문서를 업데이트합니다.
• 코딩 에이전트에 저장소 컨텍스트 제공: Cursor, Claude Code, Codex를 사용하는 개발자는 저장소를 직접 탐색하지 않고도 규칙과 검증된 명령을 가져올 수 있습니다.
• 주간 문서 드리프트 검토: 정기적인 정리 주기를 원하는 팀은 개별적으로 오래된 페이지를 쫓기보다 docs-only Friday Cleanup PR을 검토할 수 있습니다.
• 머지 전 PR 영향 확인: 유지보수자는 풀 리퀘스트가 문서에 영향을 주는지, 또는 머지 전에 설명을 다시 써야 하는지 확인할 수 있습니다.
• 신규 엔지니어 온보딩: 새 기여자는 여러 소스 파일을 읽지 않고도 한 작업 공간에서 생성된 문서와 북마크를 검색해 규칙을 이해할 수 있습니다.

FAQ

Moxie가 코드를 자동으로 변경하나요? 아니요. 소스에 따르면 코드 변경은 팀의 제어하에 유지됩니다. 문서 업데이트는 검토 가능한 docs-only 풀 리퀘스트로 제공되며, 설명 일치 조정은 코드를 바꾸는 대신 PR 설명을 수정합니다.

저장소를 연결하면 어떻게 되나요? Moxie가 저장소를 인덱싱하고, 검색 가능한 문서를 생성하고, 규칙을 요약하며, 새 풀 리퀘스트의 문서 영향과 설명 일치 여부를 검사하기 시작합니다.

저장소 접근 범위가 제한되나요? 네. 제품 설명에 따르면 접근은 기본적으로 읽기 전용이며 저장소별로 범위가 제한되고, MCP 컨텍스트도 전체 코드베이스가 아니라 작업에 한정됩니다.

어떤 종류의 문서를 생성하나요? 이 페이지에는 특히 아키텍처 페이지, 규칙, 워크스루, 그리고 결제 웹훅과 같은 주제의 문서가 언급되어 있습니다.

GitHub에서만 작동하나요? 이 페이지는 GitHub 저장소를 기준으로 작성되어 있으므로, 여기서 설명하는 지원 소스는 GitHub입니다.

대안

• Markdown 또는 docs wiki로 수동 문서화: 가장 단순한 대안이지만, 문서를 코드와 자동으로 재검증하거나 출처가 표시된 업데이트를 생성하지는 않습니다.
• 범용 코드 검색 및 저장소 탐색 도구: 파일을 살펴보는 데는 도움이 되지만, 유지 관리되는 문서 레이어나 docs-only 정리 PR은 제공하지 않습니다.
• repo 인식 docs가 없는 독립형 AI 코딩 어시스턴트: 질문에 답하고 코드를 수정할 수는 있지만, Moxie 같은 시스템과 함께 쓰지 않으면 모델이 컨텍스트를 다시 찾아야 합니다.
• pull request와 리뷰를 중심으로 한 내부 docs 워크플로: 팀은 PR을 통해 문서를 수동으로 관리할 수 있지만, 코드베이스에서 생성되는 대신 드리프트 체크를 직접 만들고 추적해야 합니다.