Skip to content

docs: add guidance for code block highlight line numbers to AGENTS.md #88430

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.

Sign up for GitHub

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

Jump to bottom
Merged
timneutkens merged 1 commit into from
Jan 12, 2026
Merged

docs: add guidance for code block highlight line numbers to AGENTS.md #88430

timneutkens merged 1 commit into from
Jan 12, 2026

Conversation

@timneutkens
Copy link
Member

@timneutkens timneutkens commented Jan 12, 2026 •
edited
Loading

Summary

Adds a note to AGENTS.md reminding AI agents to carefully count line numbers when adding highlight={...} attributes to documentation code blocks.

Changes

  • Added "Documentation Code Blocks" subsection under Development Anti-Patterns in AGENTS.md
  • Documents the importance of accounting for empty lines, imports, and type imports when specifying highlight line numbers

@nextjs-bot nextjs-bot added the created-by: Turbopack team PRs by the Turbopack team. label Jan 12, 2026
@timneutkens timneutkens marked this pull request as ready for review January 12, 2026 15:10
@timneutkens Graphite App
Copy link
Member Author

timneutkens commented Jan 12, 2026

This stack of pull requests is managed by Graphite. Learn more about stacking.

@timneutkens timneutkens changed the title docs: fix incorrect highlight line numbers in fonts documentation docs: add guidance for code block highlight line numbers to AGENTS.md Jan 12, 2026
vercel[bot]
vercel bot reviewed Jan 12, 2026
View reviewed changes
@nextjs-bot
Copy link
Collaborator

nextjs-bot commented Jan 12, 2026

Stats from current PR

✅ No significant changes detected

📊 All Metrics
📖 Metrics Glossary

Dev Server Metrics:

  • Listen = TCP port starts accepting connections
  • First Request = HTTP server returns successful response
  • Cold = Fresh build (no cache)
  • Warm = With cached build artifacts

Build Metrics:

  • Fresh = Clean build (no .next directory)
  • Cached = With existing .next directory

Change Thresholds:

  • Time: Changes < 50ms AND < 10%, OR < 2% are insignificant
  • Size: Changes < 1KB AND < 1% are insignificant
  • All other changes are flagged to catch regressions

⚡ Dev Server

Metric Canary PR Change Trend
Cold (Listen) 455ms 455ms ✓ ▁▁▁▁█
Cold (Ready in log) 439ms 439ms ✓ ▇▇▆█▅
Cold (First Request) 1.153s 1.164s ✓ ▇███▃
Warm (Listen) 457ms 456ms ✓ ▁▁▁▁█
Warm (Ready in log) 443ms 444ms ✓ ▁▁▁▁█
Warm (First Request) 344ms 347ms ✓ █▂▂▁▆
📦 Dev Server (Webpack) (Legacy)

📦 Dev Server (Webpack)

Metric Canary PR Change Trend
Cold (Listen) 455ms 456ms ✓ ███▁▁
Cold (Ready in log) 438ms 436ms ✓ ██▇▁▇
Cold (First Request) 1.740s 1.740s ✓ █▅▅▁▄
Warm (Listen) 457ms 455ms ✓ ▅▅▁▁▅
Warm (Ready in log) 437ms 437ms ✓ ▇▇▇▁█
Warm (First Request) 1.741s 1.761s ✓ █▆▆▁▇

⚡ Production Builds

Metric Canary PR Change Trend
Fresh Build 4.070s 4.085s ✓ ▁▁▂▂█
Cached Build 4.093s 4.108s ✓ ▁▂▁▂█
📦 Production Builds (Webpack) (Legacy)

📦 Production Builds (Webpack)

Metric Canary PR Change Trend
Fresh Build 13.903s 13.872s ✓ █▁▂▁▂
Cached Build 14.015s 13.978s ✓ █▁▂▁▂
node_modules Size 458 MB 458 MB ✓ █████
📦 Bundle Sizes

Bundle Sizes

⚡ Turbopack

Client

Main Bundles: **431 kB** → **431 kB** ✅ -10 B

82 files with content-based hashes (individual files not comparable between builds)

Server

Middleware
Canary PR Change
middleware-b..fest.js gzip 787 B 791 B ✓
Total 787 B 791 B ⚠️ +4 B
Build Details
Build Manifests
Canary PR Change
_buildManifest.js gzip 449 B 451 B ✓
Total 449 B 451 B ⚠️ +2 B

📦 Webpack

Client

Main Bundles
Canary PR Change
2086.HASH.js gzip 169 B N/A -
2161-HASH.js gzip 5.41 kB N/A -
2747-HASH.js gzip 4.48 kB N/A -
4322-HASH.js gzip 52.8 kB N/A -
ec793fe8-HASH.js gzip 62.3 kB N/A -
framework-HASH.js gzip 59.8 kB 59.8 kB ✓
main-app-HASH.js gzip 252 B 254 B ✓
main-HASH.js gzip 38.6 kB 39 kB ✓
webpack-HASH.js gzip 1.68 kB 1.68 kB ✓
1596.HASH.js gzip N/A 169 B -
2658-HASH.js gzip N/A 52.7 kB -
6349-HASH.js gzip N/A 4.46 kB -
7019-HASH.js gzip N/A 5.43 kB -
b17a3386-HASH.js gzip N/A 62.3 kB -
Total 225 kB 226 kB ⚠️ +244 B
Polyfills
Canary PR Change
polyfills-HASH.js gzip 39.4 kB 39.4 kB ✓
Total 39.4 kB 39.4 kB ✓
Pages
Canary PR Change
_app-HASH.js gzip 194 B 193 B ✓
_error-HASH.js gzip 182 B 182 B ✓
css-HASH.js gzip 336 B 335 B ✓
dynamic-HASH.js gzip 1.8 kB 1.8 kB ✓
edge-ssr-HASH.js gzip 256 B 256 B ✓
head-HASH.js gzip 352 B 349 B ✓
hooks-HASH.js gzip 385 B 384 B ✓
image-HASH.js gzip 580 B 580 B ✓
index-HASH.js gzip 259 B 258 B ✓
link-HASH.js gzip 2.5 kB 2.51 kB ✓
routerDirect..HASH.js gzip 319 B 317 B ✓
script-HASH.js gzip 385 B 387 B ✓
withRouter-HASH.js gzip 316 B 315 B ✓
1afbb74e6ecf..834.css gzip 106 B 106 B ✓
Total 7.97 kB 7.96 kB ✅ -8 B

Server

Edge SSR
Canary PR Change
edge-ssr.js gzip 125 kB 125 kB ✓
page.js gzip 241 kB 242 kB ✓
Total 366 kB 367 kB ⚠️ +501 B
Middleware
Canary PR Change
middleware-b..fest.js gzip 654 B 651 B ✓
middleware-r..fest.js gzip 155 B 156 B ✓
middleware.js gzip 32.9 kB 33.2 kB ✓
edge-runtime..pack.js gzip 842 B 842 B ✓
Total 34.6 kB 34.9 kB ⚠️ +310 B
Build Details
Build Manifests
Canary PR Change
_buildManifest.js gzip 738 B 738 B ✓
Total 738 B 738 B ✓
Build Cache
Canary PR Change
0.pack gzip 3.64 MB 3.65 MB 🔴 +6.73 kB (+0%)
index.pack gzip 98.9 kB 99.3 kB ✓
index.pack.old gzip 99.7 kB 100 kB ✓
Total 3.84 MB 3.85 MB ⚠️ +7.76 kB

🔄 Shared (bundler-independent)

Runtimes
Canary PR Change
app-page-exp...dev.js gzip 304 kB 304 kB ✓
app-page-exp..prod.js gzip 158 kB 158 kB ✓
app-page-tur...dev.js gzip 304 kB 304 kB ✓
app-page-tur..prod.js gzip 158 kB 158 kB ✓
app-page-tur...dev.js gzip 300 kB 300 kB ✓
app-page-tur..prod.js gzip 156 kB 156 kB ✓
app-page.run...dev.js gzip 300 kB 300 kB ✓
app-page.run..prod.js gzip 156 kB 156 kB ✓
app-route-ex...dev.js gzip 68.7 kB 68.7 kB ✓
app-route-ex..prod.js gzip 47.5 kB 47.5 kB ✓
app-route-tu...dev.js gzip 68.8 kB 68.8 kB ✓
app-route-tu..prod.js gzip 47.6 kB 47.6 kB ✓
app-route-tu...dev.js gzip 68.4 kB 68.4 kB ✓
app-route-tu..prod.js gzip 47.3 kB 47.3 kB ✓
app-route.ru...dev.js gzip 68.3 kB 68.3 kB ✓
app-route.ru..prod.js gzip 47.3 kB 47.3 kB ✓
dist_client_...dev.js gzip 324 B 324 B ✓
dist_client_...dev.js gzip 326 B 326 B ✓
dist_client_...dev.js gzip 318 B 318 B ✓
dist_client_...dev.js gzip 317 B 317 B ✓
pages-api-tu...dev.js gzip 41.1 kB 41.1 kB ✓
pages-api-tu..prod.js gzip 31.2 kB 31.2 kB ✓
pages-api.ru...dev.js gzip 41.1 kB 41.1 kB ✓
pages-api.ru..prod.js gzip 31.2 kB 31.2 kB ✓
pages-turbo....dev.js gzip 50.8 kB 50.8 kB ✓
pages-turbo...prod.js gzip 38.2 kB 38.2 kB ✓
pages.runtim...dev.js gzip 50.8 kB 50.8 kB ✓
pages.runtim..prod.js gzip 38.2 kB 38.2 kB ✓
server.runti..prod.js gzip 62.2 kB 62.2 kB ✓
Total 2.69 MB 2.69 MB ✓

@timneutkens timneutkens merged commit c68c6ad into canary Jan 12, 2026
163 checks passed
@timneutkens timneutkens deleted the fix-docs-highlight-line-numbers branch January 12, 2026 15:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@vercel vercel[bot] vercel[bot] left review comments

@mischnic mischnic mischnic approved these changes

Assignees

No one assigned

Labels

created-by: Turbopack team PRs by the Turbopack team.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@timneutkens @nextjs-bot @mischnic