Docs: Update FAQ and Field Types documentation to reflect current implementation
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
-
FAQ page - Update the "Built-in Field Types" list to only include implemented types, or add status indicators
-
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 -
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
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from SonicJs-Org/sonicjs
-
bug(admin/users): server error returns bare alert HTML causing black-shape visual artifactPossibly taken @lane711 claimed this today. Openbug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
SonicJs-Org/sonicjs#1211 ·
Maintainers usually reply within 1 day
-
area: api bug priority: P2
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
SonicJs-Org/sonicjs#1200 ·
Maintainers usually reply within 1 day
-
ResendProvider cannot send on Workers: unbound `fetch` stored as an instance property throws "Illegal invocation"Possibly taken @lane711 claimed this 23 days ago. Openarea: email bug priority: P1
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
SonicJs-Org/sonicjs#1099 ·
Maintainers usually reply within 1 day
-
Email plugin settings are never read: loadDbEmailSettings queries a v2 `plugins` table that does not exist in v3Possibly taken @lane711 claimed this 23 days ago. Openarea: email bug priority: P1
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
SonicJs-Org/sonicjs#1098 ·
Maintainers usually reply within 1 day
-
area: documentation bug documentation priority: P2
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
SonicJs-Org/sonicjs#1012 ·
Maintainers usually reply within 1 day
All issues in SonicJs-Org/sonicjs
Similar issues
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
Difficulty 1/5 Under an hour Newbie friendliness 78/100
lingdojo/kana-dojo#34344 · 1 comment · 5 reactions ·
Maintainers usually reply within 1 day
-
documentation good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
bug priority:low
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Konfirm-xyz/konfirm-frontend#369 ·
Maintainers usually reply within 1 day