Showcase/Soumettre votre design

Soumettre votre design

Partagez votre configuration d'annotation avec la communauté et aidez les autres à démarrer plus rapidement.

1Préparez vos fichiers

Créez un dossier avec vos fichiers de design. Le nom du dossier deviendra le slug de l'URL.

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

2Rédigez la description (index.mdx)

Créez un fichier index.mdx avec les métadonnées frontmatter et une 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.

3Soumettez via GitHub

Soumettez votre design en créant une pull request vers le dépôt du site Potato.

Forkez le dépôt potato-website
Ajoutez votre dossier de design dans content/designs/
Validez vos modifications avec un message descriptif
Créez une pull request vers la branche principale

Créer sur GitHub

Liste de vérification

Avant de soumettre, assurez-vous que votre design respecte ces exigences :

index.mdx contient tous les champs frontmatter requis
config.yaml a une syntaxe YAML valide
Les types d'annotation correspondent aux types Potato réels
La description est claire et utile
Aucune donnée sensible dans les fichiers d'exemple
Fonctionne avec la version actuelle de Potato

Ressources

Documentation Browse Existing Designs Potato Repository

Champs obligatoires

titleDesign name

descriptionBrief summary

annotationTypesList of types used

domainApplication domains

useCaseSpecific use cases

complexityDifficulty level

authorNameYour name

configFileConfig filename

versionSemantic version

updatedAtISO date string

Types d'annotation valides

radiomultiselectlikertspantextnumbersliderpairwisemultirate

Niveaux de complexité

beginnerSimple, 1-2 annotation types

intermediateMultiple types, custom logic

advancedComplex workflows, AI features

Besoin d'aide ?

Des questions sur la soumission ? Contactez-nous :

GitHub Discussions