jaredpalmer / jaredpalmer/formik

Missing documentation for interfaces like FormikConfig in https://formik.org/docs

Open
#3,904 0 comments 0 reactions 0 assignees View on GitHub
Type: Feature Request
Dominant language
TypeScript
Stars
34.3k
Forks
2.8k
PR merge metrics
No merged PRs in 30d

Description

## Feature request

### Current Behavior

example: https://formik.org/docs/api/useFormik

No paths to dive into the interfaces.
image

### Desired Behavior / Suggested Solution

Have pages and ways to dive into the interfaces in docs

### Who does this impact? Who is this for?

Reviewer of projects using this library. Not so much affecting developers, but important.

### Describe alternatives you've considered

N/A

### Additional context

I'm currently referring to them through opening GitHub codespace to search `FormikConfig`

Contributor guide

Open the contributing guide

Research direction

Start with the Formik documentation page for useFormik at https://formik.org/docs/api/useFormik and inspect how its referenced interfaces are presented. Search the repository for FormikConfig and the documentation entry points to understand the existing navigation. Done means users can reach pages describing the relevant interfaces from the API documentation.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.