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.

3通过 GitHub 提交

通过向 Potato 网站仓库创建 Pull Request 来提交您的设计。

Fork potato-website 仓库
将您的设计文件夹添加到 content/designs/
使用描述性提交信息提交更改
向 main 分支创建 Pull Request

在 GitHub 上创建

验证清单

提交前，请确保您的设计满足以下要求：

index.mdx 包含所有必需的前置元数据字段
config.yaml 语法正确
标注类型与 Potato 实际支持的类型一致
描述清晰且有帮助
示例文件中不包含敏感数据
兼容当前 Potato 版本

资源

Documentation Browse Existing Designs Potato 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