fix(typedoc-config): use 'markdownHooks' to add 'DO NOT EDIT' comment to generated pages

[sukvvon]

🎯 Changes

In typedoc-custom-settings.ts, stop setting the DO NOT EDIT comment on page.contents in MarkdownPageEvent.BEGIN, and add it through app.renderer.markdownHooks on page.begin and index.page.begin instead. Add a patch changeset for @tanstack/typedoc-config.

✅ Checklist

• I have followed the steps in the Contributing guide.
• I have tested this code locally with pnpm test:pr.

🚀 Release Impact

• This change affects published code, and I have generated a changeset.
• This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

• Bug Fixes
  • Generated documentation pages now include a “DO NOT EDIT” comment, including the index page. Frontmatter containing each page’s ID and title remains unchanged.

[changeset-bot]

🦋 Changeset detected

Latest commit: bb7fac7

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@tanstack/typedoc-config	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

• Configuration used: defaults
• Review profile: CHILL
• Plan: Advanced
• Run ID: 978a6516-e3cb-4f7b-a1ad-7db1eac12bc6

📥 Commits

Reviewing files that changed from the base of the PR and between 7bbdf58 and bb7fac7.

📒 Files selected for processing: 2

• .changeset/warm-notes-stay.md
• packages/typedoc-config/src/typedoc-custom-settings.ts

Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews per hour; 0 remain after this review.

📝 Walkthrough

The Typedoc configuration now registers the generated-page warning through Markdown hooks for page and index-page events. A patch changeset describes the update.

Changes: Generated-page warning

Layer / File(s)	Summary
Register the warning comment packages/typedoc-config/src/typedoc-custom-settings.ts, .changeset/warm-notes-stay.md	The MarkdownPageEvent.BEGIN callback no longer prepends the warning to page.contents. Markdown hooks register the warning for page.begin and index.page.begin. A patch changeset records the update.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~8 minutes

Change: Bug fix

Suggested reviewers: tannerlinsley

Merge Risk: ⚪ Minimal · up to bb7fa

The generated-page warning remains in the output without duplicating on the index page or disrupting frontmatter. No material merge risk is identified.

Pre-merge checks: 4 · 1

Failed checks: 1 warning

Check name	Status	Explanation	Resolution
Docstring Coverage		Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 1 files. (1 skipped: 1 …	Write docstrings for the functions missing them to satisfy the coverage threshold.

Passed checks: 4 passed

Check name	Status	Explanation
Description check		The description includes all required sections. It clearly explains the markdownHooks change, records both checklist items as complete, and identifies the patch changeset for `@tanstack/typedoc-conf…
Title check		The title clearly and concisely describes the main change: using markdownHooks to add the DO NOT EDIT comment to generated pages.
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.

Full details: Docstring Coverage

Explanation

Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 1 files. (1 skipped: 1 unsupported.)

• Fix all pre-merge checks with AI

✨ Finishing Touches: 💡 1

📝 Generate docstrings: 💡

• Commit to this branch
• Create a new PR

🧪 Generate unit tests (beta)

• Commit to this branch
• Create a new PR

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Warning

Some tools did not complete. Review the errors below.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/typedoc-config/src/typedoc-custom-settings.ts

ESLint skipped: missing config or dependency (missing-dependency). The ESLint configuration references a package that is not available in the sandbox.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[github-actions]

🚀 Changeset Version Preview

1 package(s) bumped directly, 0 bumped as dependents.

🟩 Patch bumps

Package	Version	Reason
@tanstack/typedoc-config	0.3.4 → 0.3.5	Changeset

[nx-cloud]

View your CI Pipeline Execution ↗ for commit bb7fac7

Command	Status	Duration	Result
nx run-many --target=build	✅ Succeeded	1s	View ↗
nx affected --targets=test:sherif,test:docs,tes...	✅ Succeeded	3s	View ↗

---

☁️ Nx Cloud last updated this comment at 2026-10-15 08:14:28 UTC

[nx-cloud]

View your CI Pipeline Execution ↗ for commit bb7fac7

Command	Status	Duration	Result
nx run-many --target=build	✅ Succeeded	1s	View ↗
nx affected --targets=test:sherif,test:docs,tes...	✅ Succeeded	3s	View ↗

---

☁️ Nx Cloud last updated this comment at 2026-10-15 08:14:28 UTC

[pkg-pr-new]

npm i https://pkg.pr.new/@tanstack/eslint-config@419

npm i https://pkg.pr.new/@tanstack/publish-config@419

npm i https://pkg.pr.new/@tanstack/typedoc-config@419

npm i https://pkg.pr.new/@tanstack/vite-config@419

commit: bb7fac7