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 webサイトリポジトリにプルリクエストを作成してデザインを投稿します。

  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