Skip to content
Showcase/Ihr Design einreichen

Ihr Design einreichen

Teilen Sie Ihre Annotationskonfiguration mit der Community und helfen Sie anderen, schneller loszulegen.

1Dateien vorbereiten

Erstellen Sie einen Ordner mit Ihren Design-Dateien. Der Ordnername wird zum 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

2Beschreibung schreiben (index.mdx)

Erstellen Sie eine index.mdx-Datei mit Frontmatter-Metadaten und einer Beschreibung.

---
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Über GitHub einreichen

Reichen Sie Ihr Design ein, indem Sie einen Pull Request an das Potato-Website-Repository erstellen.

  1. Das potato-website-Repository forken
  2. Ihren Design-Ordner zu content/designs/ hinzufügen
  3. Änderungen mit einer beschreibenden Nachricht committen
  4. Einen Pull Request zum Hauptzweig erstellen
Auf GitHub erstellen

Validierungs-Checkliste

Stellen Sie vor dem Einreichen sicher, dass Ihr Design diese Anforderungen erfüllt:

  • index.mdx enthält alle erforderlichen Frontmatter-Felder
  • config.yaml ist gültige YAML-Syntax
  • Annotationstypen entsprechen den tatsächlichen Potato-Typen
  • Beschreibung ist klar und hilfreich
  • Keine sensiblen Daten in Beispieldateien
  • Funktioniert mit der aktuellen Potato-Version

Ressourcen

DocumentationBrowse Existing DesignsPotato Repository

Pflichtfelder

titleDesign name
descriptionBrief summary
annotationTypesList of types used
domainApplication domains
useCaseSpecific use cases
complexityDifficulty level
authorNameYour name
configFileConfig filename
versionSemantic version
updatedAtISO date string

Gültige Annotationstypen

radiomultiselectlikertspantextnumbersliderpairwisemultirate

Komplexitätsstufen

beginnerSimple, 1-2 annotation types
intermediateMultiple types, custom logic
advancedComplex workflows, AI features

Hilfe benötigt?

Fragen zum Einreichen? Kontaktieren Sie uns:

GitHub Discussions