Add made-up example files and a beginner walkthrough

Abierto Apto para principiantes
  • ¿Algo no está bien?
#31 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
82/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
javascript
Área
documentation

Línea de trabajo

Empieza con docs/quick-start.md y docs/field-kit.md para conocer los pasos actuales de uso de las herramientas; después, añade la guía y enlázala desde docs/README.md. Incluye los ejemplos solicitados de CSV y texto inventados, con nombres de columnas que coincidan con el recorrido. El trabajo estará terminado cuando se puedan abrir los archivos, funcionen los enlaces y una persona principiante pueda seguir los pasos sin depender de resultados exactos del modelo.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

documentation good first issue help wanted

Effort: Low
Priority: Low

What is missing

The quick-start guide tells people to use safe, made-up data while learning Field Station AI. It does not provide a small set of ready-to-download files with a matching walkthrough.

A new user may not know how to prepare the first spreadsheet or which columns to choose.

Suggested change

Add a small example folder containing:

  1. A short CSV file with an item ID and a text column for a text-analysis tool.
  2. Two small CSV files that can be combined with the CSV Combiner.
  3. A short text file that can be used with the summary tool.

CSV is a plain-text spreadsheet format. Every value and statement in these files must be invented. Do not use real participant records, private filenames, or copied interview content.

Write a short guide showing how to download each example, open the correct tool, choose the inputs, and save the result. Explain that model answers may vary; do not promise exact emotion scores or summary wording.

Where to start

See the quick-start guide and Field Kit guide. Add the new guide to the documentation index.

This is a documentation and example-data task. No application behavior needs to change.

How to check the change

  • All example files download and open correctly.
  • A beginner can follow the guide without inventing missing steps.
  • Spreadsheet column names match the guide.
  • Every example contains only made-up information.
  • The guide describes the app's current behavior and has working links.

Read AGENTS.md and the repository's documentation skill before editing the guide.

Contributions welcome!

Lenguaje dominante
HTML
Estrellas
1
Forks
0
Merge medio
5 h 16 min
PR fusionados (30 d)
10

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de DepressionCenter/FieldStationAI

Todos los issues de DepressionCenter/FieldStationAI

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.