docs: Better inform users about supported Nextjs versions
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1.6k
- Forks
- 155
- Avg merge
- 1d 18h
- Merged PRs (30d)
- 20
Description
Documentation should reflect the supported Next.js and React versions and other system requirements that people might need to know, before using the package.
Acceptance Criteria
- README.md includes supported Nextjs versions.
- https://github.com/wpengine/faustjs.org includes supported Nextjs versions
Contributor 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.
Research direction
Start by reviewing README.md and the documentation on faustjs.org for existing system requirements and version references. Update both locations so they state the supported Next.js versions, along with the requested React and other requirements where appropriate. Done means the acceptance criteria are satisfied in both places.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- nextjs, react
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 78/100