Docs: Update FAQ and Field Types documentation to reflect current implementation

Abierto Apto para principiantes
#471 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
72/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
typescript

Línea de trabajo

Empieza con la lista "Built-in Field Types" en www/src/app/faq/page.mdx (líneas 166-177) y luego comprueba el estado de implementación que indica el issue frente a packages/core/src/templates/pages/admin-field-types.template.ts. Elige la Opción 1 o la Opción 2 del issue, aplícala a la lista de la FAQ y revisa si www/src/app/collections/page.mdx necesita el mismo cambio. Está terminado cuando cada tipo de campo nombrado en la FAQ coincida con el estado de la UI de administración que describe el issue.

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

Descripción

Summary

The FAQ page and field types documentation list features that are not yet fully implemented, which can mislead users about current capabilities.

Current Issues

FAQ Page (www/src/app/faq/page.mdx)

Lines 166-177 list "Built-in Field Types" including:

  • Repeaters (nested content) - NOT fully implemented (no admin UI)
  • Groups (field grouping) - NOT fully implemented (no admin UI)
  • Relations - Partially implemented (type exists, limited UI)
Actual Implementation Status

Fully implemented with admin UI:

  • text, textarea, richtext, number, boolean, date, datetime, slug, select, media

Plugin-based (require plugin activation):

  • quill, mdxeditor

Defined in types but lacking admin UI:

  • array, object, reference, multiselect, checkbox, radio, email, url, markdown, json, color, file

Proposed Changes

Option 1: Update docs to reflect reality

Remove or clearly mark features as "Coming Soon" or "Planned"

Option 2: Add implementation status indicators

Add badges or notes like:

  • ✅ Fully implemented
  • 🚧 In development
  • 📋 Planned
Specific Changes Needed
  1. FAQ page - Update the "Built-in Field Types" list to only include implemented types, or add status indicators

  2. Field Types reference (packages/core/src/templates/pages/admin-field-types.template.ts) - Already fairly accurate, but could note which types are in admin UI vs API-only

  3. Collections documentation - Clarify what field types work in the visual collection builder vs code-only

Files to Update

  • www/src/app/faq/page.mdx (lines 166-177)
  • Potentially www/src/app/collections/page.mdx
  • Consider adding a dedicated field types reference page to the docs site

Related

  • #470 - Feature request for repeater/blocks implementation
  • Originated from Discord community feedback
Lenguaje dominante
TypeScript
Estrellas
1.8k
Forks
219
Merge medio
2 d 21 h
PR fusionados (30 d)
67

Preparar el entorno

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 SonicJs-Org/sonicjs

Todos los issues de SonicJs-Org/sonicjs

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.