Showcase/Submit Your Design

Submit Your Design

Share your annotation configuration with the community and help others get started faster.

1Prepare Your Files

Create a folder with your design files. The folder name will become the URL slug.

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

2Write the Description (index.mdx)

Create an index.mdx file with frontmatter metadata and a description.

---
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.

3Submit via GitHub

Submit your design by creating a pull request to the Potato website repository.

Fork the potato-website repository
Add your design folder to content/designs/
Commit your changes with a descriptive message
Create a pull request to the main branch

Create on GitHub

Validation Checklist

Before submitting, ensure your design meets these requirements:

index.mdx has all required frontmatter fields
config.yaml is valid YAML syntax
Annotation types match actual Potato types
Description is clear and helpful
No sensitive data in sample files
Works with current Potato version

Resources

Documentation Browse Existing Designs Potato Repository

Required Fields

titleDesign name

descriptionBrief summary

annotationTypesList of types used

domainApplication domains

useCaseSpecific use cases

complexityDifficulty level

authorNameYour name

configFileConfig filename

versionSemantic version

updatedAtISO date string

Valid Annotation Types

radiomultiselectlikertspantextnumbersliderpairwisemultirate

Complexity Levels

beginnerSimple, 1-2 annotation types

intermediateMultiple types, custom logic

advancedComplex workflows, AI features

Need Help?

Questions about submitting? Reach out to us:

GitHub Discussions