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

Aperta Adatta ai principianti
#471 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
72/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
typescript
Ambito
documentation

Direzione di ricerca

Inizia dall'elenco "Built-in Field Types" in www/src/app/faq/page.mdx (righe 166-177), poi verifica lo stato di implementazione indicato nell'issue rispetto a packages/core/src/templates/pages/admin-field-types.template.ts. Scegli l'Opzione 1 o l'Opzione 2 dell'issue, applicala all'elenco della FAQ e verifica se www/src/app/collections/page.mdx richiede la stessa modifica. Il lavoro è completato quando ogni tipo di campo citato nella FAQ corrisponde allo stato dell'interfaccia di amministrazione descritto nell'issue.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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
Lingua principale
TypeScript
Stelle
1.8k
Fork
219
Merge medio
2g 21h
PR unite (30g)
67

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di SonicJs-Org/sonicjs

Tutte le issue di SonicJs-Org/sonicjs

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.