Skip to content

chore(docs): regenerate the API reference to unblock ci (lint) - #3419

Merged
kojiwakayama merged 2 commits into
mainfrom
chore/regenerate-api-reference
Aug 6, 2026
Merged

kojiwakayama merged 2 commits into
mainfrom
chore/regenerate-api-reference

Conversation

@kojiwakayama

Copy link
Copy Markdown
Contributor

Description

deno task docs:api-reference:check fails on main, so the ci (lint) job is red on every open pull request regardless of what the branch changes.

Reproduced on 59fe62c4c (current main) with 41 modules reported outdated, and on the older eae9c56e6 with the identical 41 set, so this has been red for a while. It is not caused by any one PR: I first hit it on #3416, measured the branch and a clean origin/main checkout, and the outdated sets were byte-identical.

The drift is mechanical

Source links carry a line anchor. Symbols moved, and the committed reference still points at the old lines:

-.../src/react/runtime/core.ts#L410
+.../src/react/runtime/core.ts#L409

Most of the diff follows from that one substitution: the link text changes length, so the markdown table columns re-pad. One entry, AGENT_CATALOG_KINDS, gains a line anchor its committed link lacked.

Nothing about the documented surface changes

  • Documented symbols: 4522 before, 4522 after, none added, none removed.
  • Insertions and deletions match exactly: 4915 each.

I checked that rather than assuming it, because a symmetric diff across 41 generated files could equally have meant a non-deterministic generator, which regeneration would not fix. It isn't: normalizing #L<n> collapses almost the entire diff, and the residue is table padding plus that one anchor.

Related Issue(s)

None filed. Found while getting ci (lint) green on #3416.

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update
  • Code refactoring
  • Performance improvement
  • Test update

Checklist

  • I have made corresponding changes to the documentation (if applicable)
  • I have added tests that prove my fix is effective or that my feature works

No tests: this is generated output, and docs:api-reference:check is the test.

Verification

  • Before: docs:api-reference:check exits 1, 41 outdated.
  • After: exits 0, 0 outdated.
  • Produced solely by deno task docs, which is what the check's failure message instructs.

Note

This is generated output, so it conflicts with any other branch that regenerates the same files. Worth merging promptly, or closing in favour of whoever gets there first. #3416 carries no docs change of its own: the reference lists top-level symbols rather than interface fields, so the option it adds to StartProductionServerOptions does not alter the generated output.

@kojiwakayama
kojiwakayama requested a review from kwakayama as a code owner August 6, 2026 07:11
Copilot AI review requested due to automatic review settings August 6, 2026 07:11
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@coderabbitai

coderabbitai Bot commented Aug 6, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@kojiwakayama, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 17 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: daddecf6-89bc-42da-8b92-771c6c43a00e

📥 Commits

Reviewing files that changed from the base of the PR and between 59fe62c and c153003.

📒 Files selected for processing (41)
  • docs/api-reference/veryfront/agent.md
  • docs/api-reference/veryfront/chat.md
  • docs/api-reference/veryfront/context.md
  • docs/api-reference/veryfront/embedding.md
  • docs/api-reference/veryfront/errors.md
  • docs/api-reference/veryfront/eval.md
  • docs/api-reference/veryfront/extensions.md
  • docs/api-reference/veryfront/fonts.md
  • docs/api-reference/veryfront/fs.md
  • docs/api-reference/veryfront/head.md
  • docs/api-reference/veryfront/index.client.md
  • docs/api-reference/veryfront/index.md
  • docs/api-reference/veryfront/integrations.md
  • docs/api-reference/veryfront/knowledge.md
  • docs/api-reference/veryfront/markdown.md
  • docs/api-reference/veryfront/mcp.md
  • docs/api-reference/veryfront/mdx.md
  • docs/api-reference/veryfront/metrics.md
  • docs/api-reference/veryfront/middleware.md
  • docs/api-reference/veryfront/oauth.md
  • docs/api-reference/veryfront/observability.md
  • docs/api-reference/veryfront/prompt.md
  • docs/api-reference/veryfront/provider.md
  • docs/api-reference/veryfront/release-assets.md
  • docs/api-reference/veryfront/resource.md
  • docs/api-reference/veryfront/router.md
  • docs/api-reference/veryfront/runs.md
  • docs/api-reference/veryfront/sandbox.md
  • docs/api-reference/veryfront/schedule.md
  • docs/api-reference/veryfront/schemas.md
  • docs/api-reference/veryfront/security.md
  • docs/api-reference/veryfront/server.md
  • docs/api-reference/veryfront/skill.md
  • docs/api-reference/veryfront/task.md
  • docs/api-reference/veryfront/testing.md
  • docs/api-reference/veryfront/tool.md
  • docs/api-reference/veryfront/trigger.md
  • docs/api-reference/veryfront/ui.md
  • docs/api-reference/veryfront/utils.md
  • docs/api-reference/veryfront/webhook.md
  • docs/api-reference/veryfront/workflow.md

Comment @coderabbitai help to get the list of available commands.

@kojiwakayama

Copy link
Copy Markdown
Contributor Author

Correction: this does not fix CI. Do not merge on my say-so.

My original verification claim above ("After: exits 0, 0 outdated") is true locally only. CI still reports the same 41 modules outdated with this exact commit, c153003dc, checked out. I confirmed the failing run tested this SHA and not an older one.

What I have since established:

  • docs:api-reference:check fails on clean origin/main too (41 outdated on 59fe62c4c, identical set on the older eae9c56e6). Pre-existing and repo-wide.
  • Regenerating locally makes the check pass locally, and produces a diff that touches no documented surface: 4522 symbols before and after, none added or removed.
  • The repo pins Deno 2.7.7 (.github/actions/setup-deno/action.yml), and my machine had 2.7.12. I installed 2.7.7 and regenerated with it: byte-identical output, same 41 files, same 4915/4915. So the Deno version is not the variable.
  • deno task docs does not depend on deno task generate, so post-generate sources are not the variable either.

So the generator output is environment-dependent in some way I have not isolated, and the gate cannot currently be satisfied from a developer machine: regenerate locally, commit, and CI still calls it outdated. That makes this a broken gate rather than stale content, and it is why every open PR shows a red ci (lint).

I also retract the reasoning in the description above. I argued the symmetric 4915/4915 diff proved genuine staleness rather than a non-deterministic generator, because normalizing #L<n> collapsed most of it. That was the right question and the wrong conclusion: the evidence now points at exactly the non-determinism I ruled out.

Suggested next probe

Have the check print its diff in CI, or upload the freshly generated docs/api-reference/ as an artifact, and compare it against a local run. That names the environmental input in one run. Without CI-side output there is nothing further to narrow from a dev machine.

What to do with this PR

Close it unless someone wants to land the regeneration anyway. It is a no-op for the documented surface, it conflicts with any other branch that regenerates the same files, and on the evidence above it will not turn ci (lint) green.

Copilot AI 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.

Pull request overview

Regenerates the generated docs/api-reference/veryfront/*.md API reference pages to resolve drift against the current output of deno task docs:api-reference:check, unblocking the ci (lint) job on unrelated pull requests.

Changes:

  • Regenerated API reference markdown files under docs/api-reference/veryfront/ to match the current generator output.
  • Updated many GitHub source URLs (line anchors and resulting table padding) without changing the documented symbol set.

Reviewed changes

Copilot reviewed 33 out of 41 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
docs/api-reference/veryfront/webhook.md Updates generated source links/anchors for webhook API reference.
docs/api-reference/veryfront/trigger.md Updates generated source links/anchors for trigger API reference.
docs/api-reference/veryfront/tool.md Updates generated tables and source anchors for tool APIs.
docs/api-reference/veryfront/task.md Updates generated source anchors for task APIs.
docs/api-reference/veryfront/skill.md Updates generated source anchors for skill APIs.
docs/api-reference/veryfront/server.md Updates generated source anchors for server APIs.
docs/api-reference/veryfront/security.md Updates generated source anchors for security APIs.
docs/api-reference/veryfront/schemas.md Updates generated source anchors for schemas APIs.
docs/api-reference/veryfront/schedule.md Updates generated source anchors for schedule APIs.
docs/api-reference/veryfront/sandbox.md Updates generated source anchors for sandbox APIs.
docs/api-reference/veryfront/runs.md Updates generated source anchors for runs APIs.
docs/api-reference/veryfront/router.md Updates generated source anchors for router APIs.
docs/api-reference/veryfront/resource.md Updates generated source anchors for resource APIs.
docs/api-reference/veryfront/release-assets.md Updates generated source anchors for release-assets APIs.
docs/api-reference/veryfront/prompt.md Updates generated source anchors for prompt APIs.
docs/api-reference/veryfront/oauth.md Updates generated source anchors for OAuth APIs.
docs/api-reference/veryfront/middleware.md Updates generated source anchors for middleware APIs.
docs/api-reference/veryfront/metrics.md Updates generated source anchors for metrics APIs.
docs/api-reference/veryfront/mdx.md Updates generated source anchors for MDX APIs.
docs/api-reference/veryfront/mcp.md Updates generated source anchors for MCP APIs.
docs/api-reference/veryfront/markdown.md Updates generated source anchors for markdown APIs.
docs/api-reference/veryfront/knowledge.md Updates generated source anchors for knowledge APIs.
docs/api-reference/veryfront/integrations.md Updates generated source anchors for integrations APIs.
docs/api-reference/veryfront/index.md Updates generated source anchors for root veryfront APIs.
docs/api-reference/veryfront/index.client.md Updates generated source anchors for client veryfront APIs.
docs/api-reference/veryfront/head.md Updates generated source anchors for head APIs.
docs/api-reference/veryfront/fs.md Updates generated source anchors for fs APIs.
docs/api-reference/veryfront/fonts.md Updates generated source anchors for fonts APIs.
docs/api-reference/veryfront/embedding.md Updates generated source anchors for embedding APIs.
docs/api-reference/veryfront/context.md Updates generated source anchors for context APIs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/api-reference/veryfront/router.md Outdated
kojiwakayama and others added 2 commits August 6, 2026 09:49
`deno task docs:api-reference:check` fails on main, so the `ci (lint)` job is
red on every open pull request regardless of what the branch changes.
Reproduced on 59fe62c with 41 modules reported outdated, and on the earlier
eae9c56 with the identical 41, so this has been red for a while.

The drift is mechanical. Source links carry a line anchor, symbols moved, and
the committed reference still points at the old lines:

  -.../src/react/runtime/core.ts#L410
  +.../src/react/runtime/core.ts#L409

Most of the diff follows from that: the link text changes length, so the
markdown table columns re-pad. One entry, `AGENT_CATALOG_KINDS`, gains a line
anchor its committed link lacked.

Nothing about the documented surface changes. The set of documented symbols is
identical before and after at 4522 entries, none added and none removed, and
the insertion and deletion counts match exactly at 4915 each.

Running `deno task docs` and committing the result makes the check pass, which
is what the check's own failure message asks for.
The previous regeneration was produced from a source tree that differed by
one line, so every source link in all 41 files was off by one and the
staleness check still failed.
Copilot AI review requested due to automatic review settings August 6, 2026 07:49
@kwakayama
kwakayama force-pushed the chore/regenerate-api-reference branch from c153003 to 5e60c2f Compare August 6, 2026 07:49

Copilot AI 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.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@kwakayama

Copy link
Copy Markdown
Contributor

Following up on the correction above: the gate turned out to be satisfiable from a developer machine after all, and this PR is now green. Posting the evidence rather than just the result, since the earlier conclusion was reasonable on what was observable at the time.

What was actually wrong. The committed pages had been generated against a source tree that differed from the branch by one line, so every #L anchor was off by one. Copilot spotted the same thing independently in the review thread: the row for Link pointed at core.ts#L389 while the declaration is at L390. Regenerating on top of that did not converge because the local tree that produced the original commit was not the tree CI was checking.

Fix. Regenerated against the branch source and rebased onto main in 5e60c2f77. deno task docs now yields a zero-byte diff, and docs:api-reference:check exits 0 locally.

Verified the way the correction asked. The passing ci (lint) run is 31082413469, whose headSha is 5e60c2f7770a326180e81edb2389985b4e9cdcd4, exactly this branch head. Not an older SHA.

On the non-determinism theory. It does not hold up. Regenerating on two unrelated branches (#3416 and #3397) changed exactly one file each, server.md and agent.md respectively, both matching the source those branches touched. A generator whose output depended on the environment would have churned all 41 files everywhere. Both of those PRs are green now too.

The part that is real, and is a live problem. main carries stale generated docs, so a branch cut from it inherits a red ci (lint) regardless of what it changed. That is what makes this look repo-wide. When the correction was written main was stale by 41 files; as of 540509c56 it is stale by one, provider.md, which I confirmed by running the check on a clean checkout of main. So the next PR branched from main will fail on provider.md through no fault of its own.

Worth fixing at the source. The generator embeds absolute line numbers but pins the URL to blob/main/... rather than a commit SHA, so the anchors drift out of date after merge anyway. The line-number precision generates constant staleness without buying durable accuracy. Dropping the #L anchors, or pinning to a SHA, or auto-committing the regeneration in CI would each end this class of failure. Happy to open that as a separate PR if useful.

@kojiwakayama
kojiwakayama added this pull request to the merge queue Aug 6, 2026
Merged via the queue into main with commit cef7566 Aug 6, 2026
31 checks passed
@kojiwakayama
kojiwakayama deleted the chore/regenerate-api-reference branch August 6, 2026 09:33
@kwakayama kwakayama mentioned this pull request Aug 6, 2026
1 task done
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants