Showcase/Envie seu design

Envie seu design

Compartilhe sua configuração de anotação com a comunidade e ajude outras pessoas a começar mais rápido.

1Prepare seus arquivos

Crie uma pasta com os arquivos do seu design. O nome da pasta vira o slug da URL.

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

2Escreva a descrição (index.mdx)

Crie um arquivo index.mdx com os metadados do frontmatter e uma descrição.

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

3Envie pelo GitHub

Envie seu design criando um pull request para o repositório do site do Potato.

Faça um fork do repositório potato-website
Adicione a pasta do seu design em content/designs/
Faça commit das suas alterações com uma mensagem descritiva
Crie um pull request para a branch principal

Criar no GitHub

Lista de verificação de validação

Antes de enviar, confirme que seu design atende a estes requisitos:

O index.mdx tem todos os campos obrigatórios do frontmatter
O config.yaml tem sintaxe YAML válida
Os tipos de anotação correspondem aos tipos reais do Potato
A descrição é clara e útil
Não há dados sensíveis nos arquivos de exemplo
Funciona com a versão atual do Potato

Recursos

Documentation Browse Existing Designs Potato Repository

Campos obrigatórios

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 anotação válidos

radiomultiselectlikertspantextnumbersliderpairwisemultirate

Níveis de complexidade

beginnerSimple, 1-2 annotation types

intermediateMultiple types, custom logic

advancedComplex workflows, AI features

Precisa de ajuda?

Dúvidas sobre o envio? Fale com a gente:

GitHub Discussions