json-schema-org / json-schema-org/website
✨ Enhancement: Improve Next.js build configuration readability and documentation
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 169
- Forks
- 484
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 6
Description
Is your feature request related to a problem? Please describe
The current Next.js configuration (next.config.js) contains custom Webpack logic,
static export settings, and image optimization overrides that work correctly but
are difficult to understand for new contributors.
Improving documentation and structure would make the build setup clearer and
reduce onboarding friction.
- Custom Webpack rules are embedded directly in
next.config.js - Limited inline documentation explaining:
- Why
output: 'export'is required - Why
images.unoptimizedis enabled - How environment-based conditions (
dev,isServer) are intended to work
- Why
Describe the solution you'd like
- Improve readability of
next.config.js - Add comments explaining non-default Next.js and Webpack settings
- Clarify environment-specific behavior without changing functionality
Describe alternatives you've considered
Leave the configuration as-is, but this continues to make onboarding harder
and increases the risk of accidental misconfiguration.
Additional context
This change is documentation- and structure-focused only and does not propose
any functional or behavioral changes.
Are you working on this?
Yes
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 with next.config.js, focusing on the embedded Webpack logic, output: 'export', images.unoptimized, and the dev/isServer conditions. Improve the structure and add comments explaining these non-default settings without changing functionality, then verify the build configuration still behaves as before.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- next.js, webpack
- Domain
- build-system
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100