Skip to content
Showcase/내 디자인 제출

내 디자인 제출

주석 설정을 커뮤니티와 공유하고 다른 사람들이 더 빨리 시작하도록 도와주세요.

1파일 준비

디자인 파일이 담긴 폴더를 만드세요. 폴더 이름이 URL 슬러그가 됩니다.

your-design-name/
├── index.mdx          # Required: Design description
├── config.yaml        # Required: Potato configuration
├── sample-data.json   # Optional: Example data
└── preview.png        # Optional: Screenshot

2설명 작성 (index.mdx)

프런트매터 메타데이터와 설명이 담긴 index.mdx 파일을 만드세요.

---
title: Your Design Title
description: A brief description of what this design does.
annotationTypes:
  - radio
  - multiselect
  - text
domain:
  - NLP
  - Social Media
useCase:
  - classification
  - sentiment analysis
complexity: beginner  # beginner | intermediate | advanced
featured: false
authorName: Your Name
authorAffiliation: Your Organization (optional)
authorGithub: your-github-username (optional)
configFile: config.yaml
version: "1.0.0"
updatedAt: "2024-01-15"
tags:
  - sentiment
  - social media
---

# Your Design Title

Describe your design here. Explain:

## Use Case

What problem does this solve? Who is it for?

## Key Features

- Feature 1
- Feature 2

## Data Format

Show example data structure.

## Best Practices

Tips for using this design effectively.

3GitHub로 제출

Potato 웹사이트 저장소에 풀 리퀘스트를 생성해 디자인을 제출하세요.

  1. potato-website 저장소를 포크합니다
  2. content/designs/에 디자인 폴더를 추가합니다
  3. 설명이 담긴 메시지로 변경 사항을 커밋합니다
  4. main 브랜치로 풀 리퀘스트를 생성합니다
GitHub에서 생성

검증 체크리스트

제출하기 전에 디자인이 다음 요건을 충족하는지 확인하세요:

  • index.mdx에 필수 프런트매터 필드가 모두 있음
  • config.yaml이 유효한 YAML 구문임
  • 주석 유형이 실제 Potato 유형과 일치함
  • 설명이 명확하고 유용함
  • 샘플 파일에 민감한 데이터가 없음
  • 현재 Potato 버전에서 작동함

리소스

DocumentationBrowse Existing DesignsPotato Repository

필수 필드

titleDesign name
descriptionBrief summary
annotationTypesList of types used
domainApplication domains
useCaseSpecific use cases
complexityDifficulty level
authorNameYour name
configFileConfig filename
versionSemantic version
updatedAtISO date string

유효한 주석 유형

radiomultiselectlikertspantextnumbersliderpairwisemultirate

복잡도 수준

beginnerSimple, 1-2 annotation types
intermediateMultiple types, custom logic
advancedComplex workflows, AI features

도움이 필요하신가요?

제출에 관해 궁금한 점이 있으신가요? 연락해 주세요:

GitHub Discussions