NemoClaw 문서 기여

이 가이드에서는 NemoClaw 문서를 작성, 편집, 검토하는 방법을 설명합니다. 사용자에게 영향을 미치는 코드를 변경했다면, 같은 PR에서 관련 문서도 업데이트하세요.

에이전트 스킬 활용

AI 코딩 에이전트(Cursor, Claude Code, Codex 등)를 사용하고 있다면, 저장소에 문서 작업을 자동화하는 스킬이 포함되어 있습니다. 처음부터 작성하기 전에 먼저 시도해 보세요.

스킬은 .agents/skills/에 있으며, 아래 스타일 가이드를 자동으로 따릅니다. 에이전트에게 실행을 요청하세요. 예: “v0.2.0 이후 머지된 내용을 문서에 반영해 줘”.

문서 업데이트 시점

변경 사항이 다음에 해당하면 문서를 업데이트하세요:

• CLI 명령어나 플래그를 추가, 삭제, 이름 변경.
• 기본 동작이나 설정을 변경.
• 사용자가 상호작용하는 새 기능을 추가.
• 문서에 잘못 기술된 버그를 수정.
• API, 프로토콜, 정책 스키마를 변경.

로컬 문서 빌드

문서를 빌드하고 출력을 확인합니다.

빌드 명령어:

make docs

로컬 서빙과 변경 시 자동 리빌드:

make docs-live

작성 규칙

형식

• 문서는 MyST Markdown(Sphinx 호환 CommonMark 슈퍼셋)을 사용합니다.
• 모든 페이지는 YAML frontmatter(title, description, topics, tags, content type)로 시작합니다.
• frontmatter 뒤에 SPDX 라이선스 헤더를 포함합니다.

페이지 구조

1. title.page 값과 일치하는 H1 제목.
2. 페이지에서 다루는 내용을 설명하는 1~2문장 소개.
3. H2와 H3로 작업 또는 개념별로 섹션을 구성. 각 섹션은 독자를 안내하는 도입 문장으로 시작.
4. 페이지 하단에 관련 페이지 링크가 포함된 “다음 단계” 섹션.

스타일 가이드

동료에게 설명하듯 작성하세요. 직접적이고, 구체적이고, 간결하게.

문체

• 능동태를 사용합니다. “CLI가 gateway를 생성한다”이지, “gateway가 CLI에 의해 생성된다”가 아닙니다.
• 독자를 2인칭(“여러분” 또는 반말체)으로 호칭합니다.
• 현재 시제를 사용합니다.
• 사실을 진술합니다. “간단히”, “쉽게” 같은 모호한 수식어를 피합니다.

용어

다음을 일관되게 사용하세요:

문서 변경 제출

1. 프로젝트 규칙에 따라 브랜치를 생성합니다.
2. 변경을 수행합니다.
3. make docs로 로컬 빌드 후 출력을 확인합니다.
4. docs:를 conventional commit 타입으로 PR을 생성합니다.

docs: update quickstart for new onboard wizard

문서 변경이 코드 변경과 함께라면 같은 PR에 넣고, 코드 변경의 commit 타입을 사용하세요:

feat(cli): add policy-add command

문서 PR 검토

문서 검토 시:

• 스타일 가이드 준수 여부를 확인합니다.
• LLM 생성 패턴(과도한 볼드, 대시, 필러)에 주의합니다.
• 코드 예제가 정확하고 실행 가능한지 검증합니다.
• 교차 참조와 링크가 깨지지 않았는지 확인합니다.
• 로컬 빌드로 렌더링을 확인합니다.