Showcase/Invia il tuo design

Invia il tuo design

Condividi la tua configurazione di annotazione con la comunità e aiuta gli altri a iniziare più velocemente.

1Prepara i tuoi file

Crea una cartella con i file del tuo design. Il nome della cartella diventerà lo slug dell'URL.

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

2Scrivi la descrizione (index.mdx)

Crea un file index.mdx con metadati frontmatter e una descrizione.

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

3Invia tramite GitHub

Invia il tuo design creando una pull request al repository del sito web di Potato.

Fai il fork del repository potato-website
Aggiungi la tua cartella di design a content/designs/
Fai il commit delle modifiche con un messaggio descrittivo
Crea una pull request al ramo principale

Crea su GitHub

Lista di controllo per la validazione

Prima di inviare, assicurati che il tuo design soddisfi questi requisiti:

index.mdx contiene tutti i campi frontmatter obbligatori
config.yaml è sintassi YAML valida
I tipi di annotazione corrispondono ai tipi effettivi di Potato
La descrizione è chiara e utile
Nessun dato sensibile nei file di esempio
Funziona con la versione corrente di Potato

Risorse

Documentation Browse Existing Designs Potato Repository

Campi obbligatori

titleDesign name

descriptionBrief summary

annotationTypesList of types used

domainApplication domains

useCaseSpecific use cases

complexityDifficulty level

authorNameYour name

configFileConfig filename

versionSemantic version

updatedAtISO date string

Tipi di annotazione validi

radiomultiselectlikertspantextnumbersliderpairwisemultirate

Livelli di complessità

beginnerSimple, 1-2 annotation types

intermediateMultiple types, custom logic

advancedComplex workflows, AI features

Hai bisogno di aiuto?

Domande sull'invio? Contattaci:

GitHub Discussions