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

Open Beginner friendly
#471 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
72/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
typescript
Domain
documentation

Research direction

Start with the "Built-in Field Types" list in www/src/app/faq/page.mdx (lines 166-177), then check the implementation status the issue lists against packages/core/src/templates/pages/admin-field-types.template.ts. Pick Option 1 or Option 2 from the issue, apply it to the FAQ list, and check whether www/src/app/collections/page.mdx needs the same change. Done when every field type named in the FAQ matches the admin UI status the issue describes.

Written by the indexing model from the issue text.

Description

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
Dominant language
TypeScript
Stars
1.8k
Forks
219
Avg merge
2d 21h
Merged PRs (30d)
67

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from SonicJs-Org/sonicjs

All issues in SonicJs-Org/sonicjs

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.