Thinkmill / Thinkmill/keystatic
Document object field options
Open
Nobody has claimed this yet.
documentation
- Dominant language
- TypeScript
- Stars
- 2.4k
- Forks
- 159
- Avg merge
- 21h 41m
- Merged PRs (30d)
- 2
Description
Add a section to the object field documentation detailing the options argument:
type ObjectFieldOptions = {
label: string;
description?: string;
}
Where usage looks like:
fields.object(
{
a: fields.text({ label: 'A' }),
b: fields.text({ label: 'B' }),
},
{
label: 'Group label',
description: 'Group description',
}
)
Relates to #641
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Open the object field documentation at https://keystatic.com/docs/fields/object and review the existing options documentation. Add the ObjectFieldOptions fields and the fields.object usage example shown in the issue; the work is done when label and description are clearly documented for object fields.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100