docs(next-api): trying to document project_update_info_subscribe

[kwonoj]

What?

Closes PACK-2469

Trying to add some description to the one of the public interface.

[kwonoj]

@timneutkens Would you mind elaborate any specific topics would be covered by docs for the interface?

[ijjk]

Failing test suites

Commit: 95e68dd

pnpm test-start test/e2e/app-dir/navigation/navigation.test.ts

• app dir - navigation > navigation between pages and app > should not continously initiate a mpa navigation to the same URL when router state changes

Expand output

● app dir - navigation › navigation between pages and app › should not continously initiate a mpa navigation to the same URL when router state changes

page.waitForSelector: Timeout 60000ms exceeded.
Call log:
  - waiting for locator('#link-to-slow-page')
  -   locator resolved to visible <a href="/slow-page" id="link-to-slow-page">To /slow-page</a>

  421 |     return this.chain(() => {
  422 |       return page
> 423 |         .waitForSelector(selector, { timeout, state: 'attached' })
      |          ^
  424 |         .then(async (el) => {
  425 |           // it seems selenium waits longer and tests rely on this behavior
  426 |           // so we wait for the load event fire before returning

  at waitForSelector (lib/browsers/playwright.ts:423:10)

Read more about building and testing Next.js in contributing.md.

[ijjk]

Stats from current PR

Default Build (Increase detected ⚠️)

General

	vercel/next.js canary	vercel/next.js docs-project-update-info-sub	Change
buildDuration	12.8s	11.9s	N/A
buildDurationCached	6.8s	4.8s	N/A
nodeModulesSize	196 MB	196 MB	N/A
nextStartRea..uration (ms)	425ms	425ms	✓

Client Bundles (main, webpack)

	vercel/next.js canary	vercel/next.js docs-project-update-info-sub	Change
3f784ff6-HASH.js gzip	53.5 kB	53.5 kB	N/A
423.HASH.js gzip	185 B	181 B	N/A
68-HASH.js gzip	30.3 kB	29.6 kB	N/A
framework-HASH.js gzip	45.2 kB	45.2 kB	✓
main-app-HASH.js gzip	238 B	239 B	N/A
main-HASH.js gzip	32 kB	31.9 kB	N/A
webpack-HASH.js gzip	1.7 kB	1.7 kB	✓
Overall change	46.9 kB	46.9 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	vercel/next.js docs-project-update-info-sub	Change
polyfills-HASH.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	vercel/next.js docs-project-update-info-sub	Change
_app-HASH.js gzip	194 B	195 B	N/A
_error-HASH.js gzip	182 B	181 B	N/A
amp-HASH.js gzip	502 B	501 B	N/A
css-HASH.js gzip	320 B	322 B	N/A
dynamic-HASH.js gzip	2.5 kB	2.5 kB	N/A
edge-ssr-HASH.js gzip	255 B	256 B	N/A
head-HASH.js gzip	350 B	349 B	N/A
hooks-HASH.js gzip	368 B	369 B	N/A
image-HASH.js gzip	4.2 kB	4.2 kB	N/A
index-HASH.js gzip	257 B	256 B	N/A
link-HASH.js gzip	2.67 kB	2.67 kB	N/A
routerDirect..HASH.js gzip	310 B	311 B	N/A
script-HASH.js gzip	384 B	383 B	N/A
withRouter-HASH.js gzip	306 B	308 B	N/A
1afbb74e6ecf..834.css gzip	106 B	106 B	✓
Overall change	106 B	106 B	✓

Client Build Manifests

	vercel/next.js canary	vercel/next.js docs-project-update-info-sub	Change
_buildManifest.js gzip	483 B	484 B	N/A
Overall change	0 B	0 B	✓

Rendered Page Sizes

	vercel/next.js canary	vercel/next.js docs-project-update-info-sub	Change
index.html gzip	528 B	527 B	N/A
link.html gzip	542 B	540 B	N/A
withRouter.html gzip	524 B	522 B	N/A
Overall change	0 B	0 B	✓

Edge SSR bundle Size

	vercel/next.js canary	vercel/next.js docs-project-update-info-sub	Change
edge-ssr.js gzip	94.5 kB	94.4 kB	N/A
page.js gzip	151 kB	150 kB	N/A
Overall change	0 B	0 B	✓

Middleware size Overall increase ⚠️

	vercel/next.js canary	vercel/next.js docs-project-update-info-sub	Change
middleware-b..fest.js gzip	617 B	625 B	N/A
middleware-r..fest.js gzip	151 B	149 B	N/A
middleware.js gzip	44.5 kB	47.4 kB	⚠️ +2.84 kB
edge-runtime..pack.js gzip	1.94 kB	1.94 kB	✓
Overall change	46.5 kB	49.3 kB	⚠️ +2.84 kB

Next Runtimes

	vercel/next.js canary	vercel/next.js docs-project-update-info-sub	Change
app-page-exp...dev.js gzip	166 kB	166 kB	N/A
app-page-exp..prod.js gzip	95.9 kB	95.4 kB	N/A
app-page-tur..prod.js gzip	97.6 kB	97.2 kB	N/A
app-page-tur..prod.js gzip	92 kB	91.6 kB	N/A
app-page.run...dev.js gzip	136 kB	136 kB	N/A
app-page.run..prod.js gzip	90.6 kB	90.2 kB	N/A
app-route-ex...dev.js gzip	22 kB	22 kB	N/A
app-route-ex..prod.js gzip	14.9 kB	14.9 kB	N/A
app-route-tu..prod.js gzip	14.9 kB	14.9 kB	N/A
app-route-tu..prod.js gzip	14.6 kB	14.7 kB	N/A
app-route.ru...dev.js gzip	21.7 kB	21.7 kB	N/A
app-route.ru..prod.js gzip	14.6 kB	14.7 kB	N/A
pages-api-tu..prod.js gzip	9.47 kB	9.43 kB	N/A
pages-api.ru...dev.js gzip	9.74 kB	9.7 kB	N/A
pages-api.ru..prod.js gzip	9.47 kB	9.43 kB	N/A
pages-turbo...prod.js gzip	22.1 kB	22 kB	N/A
pages.runtim...dev.js gzip	22.7 kB	22.7 kB	N/A
pages.runtim..prod.js gzip	22.1 kB	22 kB	N/A
server.runti..prod.js gzip	50.1 kB	49.9 kB	N/A
Overall change	0 B	0 B	✓

Diff details

Diff for page.js

Diff too large to display

Diff for middleware.js

Diff too large to display

Diff for edge-ssr.js

Diff too large to display

Diff for 68-HASH.js

Diff too large to display

Diff for main-HASH.js

Diff too large to display

Diff for app-page-exp..ntime.dev.js

failed to diff

Diff for app-page-exp..time.prod.js

Diff too large to display

Diff for app-page-tur..time.prod.js

Diff too large to display

Diff for app-page-tur..time.prod.js

Diff too large to display

Diff for app-page.runtime.dev.js

failed to diff

Diff for app-page.runtime.prod.js

Diff too large to display

Diff for app-route-ex..ntime.dev.js

Diff too large to display

Diff for app-route-ex..time.prod.js

Diff too large to display

Diff for app-route-tu..time.prod.js

Diff too large to display

Diff for app-route-tu..time.prod.js

Diff too large to display

Diff for app-route.runtime.dev.js

Diff too large to display

Diff for app-route.ru..time.prod.js

Diff too large to display

Diff for pages-api-tu..time.prod.js

Diff too large to display

Diff for pages-api.runtime.dev.js

Diff too large to display

Diff for pages-api.ru..time.prod.js

Diff too large to display

Diff for pages-turbo...time.prod.js

Diff too large to display

Diff for pages.runtime.dev.js

Diff too large to display

Diff for pages.runtime.prod.js

Diff too large to display

Diff for server.runtime.prod.js

Diff too large to display

Commit: 95e68dd