Skip to main content

Documentation Index

Fetch the complete documentation index at: https://daehan-base.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

이 가이드는 Base Account 문서에 새로운 기능, 콘텐츠를 추가하거나 업데이트를 수행하는 모든 기여자를 위한 것입니다. 이 가이드라인을 따르면 일관성을 유지하고 문서 구조를 유지하여 개발자들이 더 쉽게 정보를 찾을 수 있습니다.
문서가 중요한 이유좋은 문서는 개발자 도입을 크게 가속화합니다. 개발자들이 Base Account 기능을 효율적으로 이해하고 구현하는 데 도움이 되는 콘텐츠를 만드는 데 집중하면서, 문서의 구조적 완결성을 유지하세요.

​
문서 구조 가이드라인

​
핵심 원칙: 기존 구조 유지

Base Account 문서는 다음과 같은 주요 섹션으로 구성되어 있습니다:
  1. 소개
  2. 빠른 시작
  3. 가이드
  4. 프레임워크 통합
  5. 레퍼런스
  6. 더 보기
  7. 베이스네임
  8. 기여하기
새로운 최상위 섹션을 만들지 마세요모든 새로운 콘텐츠는 이 기존 섹션 내에 맞아야 합니다.

​
섹션 목적 및 콘텐츠 배치

새로운 콘텐츠를 추가할 때는 다음 기준에 따라 적절한 섹션을 결정하세요:

​
소개

  • Base Account가 무엇인지와 핵심 가치 제안에 대한 높은 수준의 설명 콘텐츠
  • 제품 포지셔닝이나 기능에 근본적인 변화가 있을 때만 업데이트

​
빠른 시작

  • 개발자들이 빠르게 시작할 수 있는 end-to-end 가이드
  • 집중적이고 간결하게 유지
  • 다양한 통합 경로 포함 (웹, React 포함 웹, 모바일)

​
가이드

  • 특정 작업 및 구현 시나리오를 위한 단계별 튜토리얼
  • 인증, 결제, UX 개선을 위한 가이드 포함
  • 다음과 같은 기능 포함:
    • 사용자 인증
    • 결제 및 반복 결제 수락
    • 배치 트랜잭션
    • 페이마스터 및 가스 후원
    • 서브 계정
    • 지출 권한
  • 행동 지향적인 제목으로 가이드 명명 (예: “결제 가이드” 대신 “결제 수락”)

​
프레임워크 통합

  • 특정 프레임워크 및 라이브러리에 대한 자세한 통합 가이드
  • 프레임워크별로 구성된 서브섹션:
    • Wagmi/Viem: 설정, 배치 트랜잭션, 베이스네임 및 기타 사용 사례
    • Privy: 설정, 인증, 지갑 작업 및 서브 계정
    • CDP: Coinbase Developer Platform 통합
    • RainbowKit: RainbowKit 통합
  • 각 프레임워크 섹션은 설정 및 일반적인 사용 사례를 포함해야 합니다

​
레퍼런스

  • API, 메서드, 컴포넌트 및 구성에 대한 포괄적인 기술 문서
  • 튜토리얼 콘텐츠가 아닌 구조화된 레퍼런스 자료
  • 매개변수 설명, 반환 값 및 사용 예시 포함
  • 컴포넌트별로 구성:
    • Account SDK: 핵심 함수, 지출 권한 유틸리티, Base Pay, 구독 및 Prolink 유틸리티
    • Provider: 메서드 (RPC 메서드: wallet_connect, wallet_sendCalls 등) 및 기능
    • UI 요소: Base Pay 버튼, Base로 로그인 버튼, 브랜드 가이드라인
    • 온체인 컨트랙트: 지출 권한, 스마트 지갑 및 베이스네임 컨트랙트

​
더 보기

  • 추가 리소스 및 보충 문서
  • 문제 해결 가이드 (팝업, 가스 사용, 지원되지 않는 호출, 시뮬레이션, 지갑 라이브러리 지원)
  • Base 가스리스 캠페인 정보
  • 텔레메트리 정보
  • 마이그레이션 가이드

​
베이스네임

  • 베이스네임 기능에 특화된 문서
  • FAQ 및 일반적인 질문
  • 베이스네임 전송 문서

​
기여하기

  • Base Account 프로젝트 기여자를 위한 정보
  • 보안 및 버그 바운티 정보
  • 기여 프로세스가 변경될 때 업데이트
서브섹션 과다 생성 방지
  • 가이드의 경우: 모든 가이드를 가이드 섹션 아래 동일한 수준으로 유지
  • 레퍼런스의 경우: 사용 사례가 아닌 컴포넌트 또는 기능별로 구성
  • 프레임워크 통합의 경우: 프레임워크별 콘텐츠를 해당 프레임워크 서브섹션 내에 유지
  • 새 서브섹션 추가가 유혹될 때, 콘텐츠를 기존 섹션에 맞게 재구성할 수 있는지 고려하세요
  • 새로운 조직 구조를 만드는 대신 관련 콘텐츠 간 교차 참조 사용

​
문서 스타일 가이드라인

​
작성 스타일

  1. 간결하게: 단순하고 직접적인 언어 사용. 불필요한 단어 피하기.
  2. 일관성: 문서 전체에서 일관된 용어 유지.
  3. 독자 중심: 독자의 페르소나를 생각하고 그에 맞게 작성.
  4. 핵심 경로: 핵심 경로에 집중하되, 대안적인 경로도 언급하는 것을 잊지 마세요.
  5. AI 친화적: AI가 이해하고 따르기 쉬운 방식으로 작성.
AI 생성 콘텐츠를 반드시 검토하세요AI를 사용하여 콘텐츠를 생성하는 경우:
  • 제출 전에 신중하게 검토하세요.
  • 콘텐츠가 이 문서의 가이드라인을 따르는지 확인하세요.
  • 콘텐츠가 AI가 이해하고 따르기 쉬운지 확인하세요.

​
AI 친화적 작성 팁

  • 파일 이름, 제목 및 콘텐츠에 명시적인 언어를 사용하세요.
  • 관련 가이드 및 예시에 능동적인 링크 참조를 만드세요.
  • 단계나 옵션에는 목록을 사용하세요.
  • 사용하는 라이브러리를 명시적으로 이름 짓고 참조하세요.
  • 코드를 강조하기 위해 코드 블록을 사용하세요.
  • 문맥 없이도 의미가 통하는 시맨틱 URL을 사용하세요. 약어를 피하세요.
대규모 언어 모델처럼 생각하세요문서를 작성할 때, 대규모 언어 모델이 콘텐츠를 어떻게 이해할지 생각해 보세요.지속적으로 스스로에게 물어보세요:
  • “대규모 언어 모델이 이 콘텐츠를 이해할 수 있을까?”
  • “대규모 언어 모델이 이 콘텐츠를 따를 수 있을까?”
  • “대규모 언어 모델이 이 콘텐츠를 사용할 수 있을까?”
이 모든 질문에 ‘예’라고 답할 수 없다면 콘텐츠를 다시 작성해야 합니다.

​
형식

  1. 마크다운 사용:
    • 적절한 제목 계층 구조 사용 (주 제목은 #, 섹션 제목은 ## 등)
    • 언어 명시가 있는 코드 블록 사용 (```javascript)
    • 매개변수 참조에는 표 사용
    • 단계나 옵션에는 목록 사용
  2. 코드 예시:
    • 완전하고 작동하는 코드 예시 포함
    • 코드에 충분한 주석 달기
    • 프로젝트의 코딩 스타일 가이드 준수

​
약어 및 용어

  1. 첫 번째 언급 시: 약어나 기술 용어를 처음 사용할 때는 괄호 안에 약어를 포함하여 전체 이름을 표기하세요. 예: “계정 추상화(Account Abstraction, AA)”
  2. 일관성: 문서 전체에서 동일한 개념에는 동일한 용어 사용
  3. 기술 레퍼런스: 가이드와 예시를 최소한의 크기로 유지하세요. 포괄적인 기술 세부 사항은 기술 레퍼런스 섹션에 넣으세요.

​
제출 전 검토 체크리스트

  • 콘텐츠가 기존 구조에 맞는지 확인
  • 새로운 최상위 섹션이 생성되지 않았는지 확인
  • 서브섹션 생성이 최소화되었는지 확인
  • 일관된 용어가 사용되었는지 확인
  • 약어가 올바르게 소개되었는지 확인
  • 코드 예시가 완전하고 작동하는지 확인
  • 관련 문서에 대한 교차 참조가 추가되었는지 확인
  • 문서가 스타일 가이드라인을 따르는지 확인
  • 문서가 AI가 이해하고 따르기 쉬운 방식으로 작성되었는지 확인

​
제출 과정

  1. 변경 사항을 포함한 문서 Pull Request(PR)를 저장소에 만드세요
  2. PR에 모든 관련 섹션 업데이트가 포함되고 이 가이드의 지침을 따르는지 확인하세요
  3. 문서 팀에 리뷰를 요청하세요
  4. 피드백을 반영하고 필요한 수정을 하세요
  5. 승인되면 PR이 병합되어 게시됩니다