Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Explain different export formats of next.config.js #51848

Open
mrienstra opened this issue Jun 26, 2023 · 2 comments
Open

Docs: Explain different export formats of next.config.js #51848

mrienstra opened this issue Jun 26, 2023 · 2 comments
Labels
Documentation Related to Next.js' official documentation. linear: dx Confirmed issue that is tracked by the DX team.

Comments

@mrienstra
Copy link

mrienstra commented Jun 26, 2023

What is the improvement or update you wish to see?

Info about various forms next.config.js can take in addition to the default (mjs, function, async function) should move from
/docs/app/api-reference/next-config-js/pageExtensions to /docs/app/api-reference/next-config-js.

Is there any context that might help us understand?

Prior to #50701, the info I think should be moved was located in docs/api-reference/next.config.js/introduction.md, but shown at https://nextjs.org/docs/app/api-reference/next-config-js/pageExtensions. See my previous issue (which predates #50701): #50192

As part of #50701, this content was moved to docs/02-app/02-api-reference/05-next-config-js/pageExtensions.mdx (permalink).

I think it would be more useful / intuitive if it was in docs/02-app/02-api-reference/05-next-config-js/index.mdx (permalink).


Aside (I can open another issue for this if desired): documentation of defaultConfig is difficult to locate, not on either of these pages, and not found via search. Just a simple example would be nice, as is done for phase.

DX-1709

@mrienstra mrienstra added the Documentation Related to Next.js' official documentation. label Jun 26, 2023
@mrienstra mrienstra changed the title Docs: Docs: next.config.js variants in odd location Jun 27, 2023
@mrienstra

This comment was marked as off-topic.

@balazsorban44 balazsorban44 changed the title Docs: next.config.js variants in odd location Docs: Explain different export formats of next.config.js Jun 28, 2023
@balazsorban44 balazsorban44 added the linear: dx Confirmed issue that is tracked by the DX team. label Jun 28, 2023
@balazsorban44
Copy link
Member

Thanks, I do agree that the https://nextjs.org/docs/app/api-reference/next-config-js page could explain a bit more about the supported formats.

In addition, each subpage/config property could mention its default value. I added this to our backlog

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Related to Next.js' official documentation. linear: dx Confirmed issue that is tracked by the DX team.
Projects
None yet
Development

No branches or pull requests

2 participants