Showcase/Envíe su diseño

Envíe su diseño

Comparta su configuración de anotación con la comunidad y ayude a otros a comenzar más rápido.

1Prepare sus archivos

Cree una carpeta con los archivos de su diseño. El nombre de la carpeta se convertirá en el slug de la URL.

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

2Escriba la descripción (index.mdx)

Cree un archivo index.mdx con metadatos en el frontmatter y una descripción.

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

3Envíe mediante GitHub

Envíe su diseño creando un pull request al repositorio del sitio web de Potato.

Haga un fork del repositorio potato-website
Añada su carpeta de diseño a content/designs/
Haga commit de sus cambios con un mensaje descriptivo
Cree un pull request a la rama principal

Crear en GitHub

Lista de verificación

Antes de enviar, asegúrese de que su diseño cumpla estos requisitos:

index.mdx tiene todos los campos de frontmatter requeridos
config.yaml tiene sintaxis YAML válida
Los tipos de anotación corresponden a tipos reales de Potato
La descripción es clara y útil
No hay datos sensibles en los archivos de ejemplo
Funciona con la versión actual de Potato

Recursos

Documentation Browse Existing Designs Potato Repository

Campos requeridos

titleDesign name

descriptionBrief summary

annotationTypesList of types used

domainApplication domains

useCaseSpecific use cases

complexityDifficulty level

authorNameYour name

configFileConfig filename

versionSemantic version

updatedAtISO date string

Tipos de anotación válidos

radiomultiselectlikertspantextnumbersliderpairwisemultirate

Niveles de complejidad

beginnerSimple, 1-2 annotation types

intermediateMultiple types, custom logic

advancedComplex workflows, AI features

¿Necesita ayuda?

¿Tiene preguntas sobre el envío? Contáctenos:

GitHub Discussions