Skip to content

chore: opt-in reading time - #1043

Open
avivkeller wants to merge 1 commit into
mainfrom
optin-reading-time
Open

chore: opt-in reading time#1043
avivkeller wants to merge 1 commit into
mainfrom
optin-reading-time

Conversation

@avivkeller

@avivkeller avivkeller commented Aug 16, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Fixes #1029

Pretty simple showReadingTime ternary to enable reading time

@avivkeller
avivkeller requested a review from a team as a code owner August 16, 2026 23:29
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Aug 16, 2026 •
edited
Loading

Copy link
Copy Markdown

🚀 Deploying Preview to Cloudflare 🚀

Preview Deployments by commit

Status Deployment URL Commit Updated (UTC) See this deployment's details
  • Build: Failed ❌

View logs ↗		 cef1084 2026-08-17T16:45:48.869Z View logs ↗
  • Build: Failed ❌

View logs ↗		 79663a2 2026-08-17T16:29:45.322Z View logs ↗
  • Build: Failed ❌

View logs ↗		 28df1dd 2026-08-16T23:29:41.923Z View logs ↗

@vercel

vercel Bot commented Aug 16, 2026 •
edited
Loading

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
api-docs-tooling Ready Ready Preview Aug 17, 2026 4:45pm

Request Review

@codecov

codecov Bot commented Aug 16, 2026 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 92.85714% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 89.57%. Comparing base (7670a78) to head (cef1084).

Files with missing lines Patch % Lines
packages/react/src/jsx-ast/utils/buildContent.mjs 92.30% 1 Missing ⚠️
Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #1043   +/-   ##
=======================================
  Coverage   89.57%   89.57%           
=======================================
  Files         203      203           
  Lines       19116    19126   +10     
  Branches     1790     1791    +1     
=======================================
+ Hits        17123    17132    +9     
- Misses       1985     1986    +1     
  Partials        8        8

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions

github-actions Bot commented Aug 16, 2026

Copy link
Copy Markdown
Contributor

api-links Generator

Performance estimate (single CI run)

  • Generation time: 9.3% slower (1.29 s → 1.41 s)
  • Peak memory: 1.3% lower (355.02 MB → 350.49 MB)

legacy-html Generator

Performance estimate (single CI run)

  • Generation time: 12.2% slower (18.49 s → 20.75 s)
  • Peak memory: 5.2% higher (2.26 GB → 2.38 GB)

legacy-json Generator

Performance estimate (single CI run)

  • Generation time: 6.9% slower (8.96 s → 9.58 s)
  • Peak memory: 2.6% lower (1.80 GB → 1.75 GB)

llms-txt Generator

Performance estimate (single CI run)

  • Generation time: 5.6% faster (8.86 s → 8.36 s)
  • Peak memory: 3.5% higher (1.72 GB → 1.78 GB)

orama-db Generator

Output size: 1 file changed · net -1.15 KB

File size details
File Main PR Change
orama-db.json 9.15 MB 9.14 MB -1.15 KB (-0.0%)

Performance estimate (single CI run)

  • Generation time: 13.8% faster (9.99 s → 8.61 s)
  • Peak memory: 0.6% higher (1.76 GB → 1.77 GB)

web Generator

Output size: 72 files changed · net -2.33 KB

File size details
File Main PR Change
all.html 31.74 MB 31.74 MB -201.00 B (-0.0%)
crypto.html 1.86 MB 1.86 MB -32.00 B (-0.0%)
fs.html 2.15 MB 2.15 MB -32.00 B (-0.0%)
n-api.html 1.00 MB 1.00 MB -32.00 B (-0.0%)
addons.html 379.26 KB 379.23 KB -31.00 B (-0.0%)
assert.html 649.18 KB 649.15 KB -31.00 B (-0.0%)
async_context.html 317.67 KB 317.64 KB -31.00 B (-0.0%)
async_hooks.html 283.33 KB 283.30 KB -31.00 B (-0.0%)
buffer.html 1.71 MB 1.71 MB -31.00 B (-0.0%)
child_process.html 666.20 KB 666.17 KB -31.00 B (-0.0%)
cli.html 580.59 KB 580.56 KB -31.00 B (-0.0%)
cluster.html 301.39 KB 301.36 KB -31.00 B (-0.0%)
debugger.html 143.42 KB 143.39 KB -31.00 B (-0.0%)
deprecations.html 536.79 KB 536.76 KB -31.00 B (-0.0%)
dgram.html 298.22 KB 298.19 KB -31.00 B (-0.0%)
diagnostics_channel.html 517.22 KB 517.19 KB -31.00 B (-0.0%)
dns.html 419.09 KB 419.06 KB -31.00 B (-0.0%)
domain.html 126.38 KB 126.35 KB -31.00 B (-0.0%)
errors.html 517.39 KB 517.36 KB -31.00 B (-0.0%)
esm.html 186.79 KB 186.76 KB -31.00 B (-0.0%)
events.html 831.00 KB 830.97 KB -31.00 B (-0.0%)
ffi.html 177.99 KB 177.96 KB -31.00 B (-0.0%)
globals.html 279.39 KB 279.36 KB -31.00 B (-0.0%)
http.html 1.10 MB 1.10 MB -31.00 B (-0.0%)
http2.html 1.24 MB 1.24 MB -31.00 B (-0.0%)
inspector.html 212.96 KB 212.93 KB -31.00 B (-0.0%)
module.html 506.19 KB 506.16 KB -31.00 B (-0.0%)
modules.html 226.98 KB 226.95 KB -31.00 B (-0.0%)
net.html 624.57 KB 624.54 KB -31.00 B (-0.0%)
packages.html 218.29 KB 218.26 KB -31.00 B (-0.0%)
perf_hooks.html 662.15 KB 662.12 KB -31.00 B (-0.0%)
process.html 1.14 MB 1.14 MB -31.00 B (-0.0%)
quic.html 902.10 KB 902.07 KB -31.00 B (-0.0%)
readline.html 361.79 KB 361.76 KB -31.00 B (-0.0%)
repl.html 302.20 KB 302.17 KB -31.00 B (-0.0%)
report.html 231.25 KB 231.22 KB -31.00 B (-0.0%)
single-executable-applications.html 132.67 KB 132.64 KB -31.00 B (-0.0%)
sqlite.html 472.59 KB 472.56 KB -31.00 B (-0.0%)
stream.html 1.22 MB 1.22 MB -31.00 B (-0.0%)
stream_iter.html 722.65 KB 722.62 KB -31.00 B (-0.0%)
test.html 1.34 MB 1.34 MB -31.00 B (-0.0%)
tls.html 511.98 KB 511.95 KB -31.00 B (-0.0%)
url.html 510.63 KB 510.60 KB -31.00 B (-0.0%)
util.html 1.16 MB 1.16 MB -31.00 B (-0.0%)
v8.html 544.02 KB 543.99 KB -31.00 B (-0.0%)
vm.html 630.98 KB 630.95 KB -31.00 B (-0.0%)
webcrypto.html 625.54 KB 625.50 KB -31.00 B (-0.0%)
webstreams.html 532.46 KB 532.43 KB -31.00 B (-0.0%)
worker_threads.html 631.12 KB 631.09 KB -31.00 B (-0.0%)
zlib.html 940.26 KB 940.23 KB -31.00 B (-0.0%)
404.html 22.00 KB 21.97 KB -30.00 B (-0.1%)
console.html 184.43 KB 184.40 KB -30.00 B (-0.0%)
documentation.html 28.65 KB 28.62 KB -30.00 B (-0.1%)
dtls.html 175.28 KB 175.25 KB -30.00 B (-0.0%)
embedding.html 59.84 KB 59.81 KB -30.00 B (-0.0%)
environment_variables.html 37.80 KB 37.77 KB -30.00 B (-0.1%)
https.html 239.91 KB 239.88 KB -30.00 B (-0.0%)
index.html 32.58 KB 32.55 KB -30.00 B (-0.1%)
intl.html 56.51 KB 56.48 KB -30.00 B (-0.1%)
os.html 164.23 KB 164.21 KB -30.00 B (-0.0%)
path.html 176.50 KB 176.47 KB -30.00 B (-0.0%)
permissions.html 75.23 KB 75.20 KB -30.00 B (-0.0%)
punycode.html 64.81 KB 64.78 KB -30.00 B (-0.0%)
querystring.html 66.83 KB 66.80 KB -30.00 B (-0.0%)
string_decoder.html 66.24 KB 66.21 KB -30.00 B (-0.0%)
synopsis.html 38.23 KB 38.20 KB -30.00 B (-0.1%)
timers.html 182.12 KB 182.09 KB -30.00 B (-0.0%)
tracing.html 126.05 KB 126.03 KB -30.00 B (-0.0%)
tty.html 102.95 KB 102.92 KB -30.00 B (-0.0%)
typescript.html 50.33 KB 50.30 KB -30.00 B (-0.1%)
vfs.html 90.10 KB 90.07 KB -30.00 B (-0.0%)
wasi.html 80.22 KB 80.19 KB -30.00 B (-0.0%)

Performance estimate (single CI run)

  • Generation time: 3.0% faster (87.47 s → 84.86 s)
  • Peak memory: 2.6% higher (4.71 GB → 4.83 GB)

araujogui
araujogui approved these changes Aug 17, 2026
View reviewed changes

@araujogui araujogui left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

bmuenzenmeyer
bmuenzenmeyer approved these changes Aug 17, 2026
View reviewed changes

@bmuenzenmeyer bmuenzenmeyer left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this would be a simple test to create too - showing its presence or not

ovflowd
ovflowd reviewed Aug 17, 2026
View reviewed changes
Comment thread packages/react/src/jsx-ast/utils/buildContent.mjs Outdated
headings: extractHeadings(entries),
readingTime: readingTime(extractTextContent(entries)).text,
readingTime: showReadingTime
? readingTime(extractTextContent(entries)).text

@ovflowd ovflowd Aug 17, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we do it conditional import of reading-time? https://github.com/nodejs/doc-kit/pull/1043/changes#diff-bb448e05dc2e1a20cf7ec3b7853a3b5ee5450ed83890c278ff9406043bed4e46R14

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bmuenzenmeyer bmuenzenmeyer bmuenzenmeyer approved these changes
@ovflowd ovflowd ovflowd approved these changes
@araujogui araujogui araujogui approved these changes
@AugustinMauroy AugustinMauroy AugustinMauroy approved these changes

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

I think the 'Reading Time' for a documentation page has no usefullness

5 participants

@avivkeller @bmuenzenmeyer @ovflowd @araujogui @AugustinMauroy