Skip to content

docs: disable generated page titles - #2378

Open
KevinVandy wants to merge 3 commits into
mainfrom
docs/remove-duplicate-page-headings
Open

KevinVandy wants to merge 3 commits into
mainfrom
docs/remove-duplicate-page-headings

Conversation

@KevinVandy

@KevinVandy KevinVandy commented Sep 10, 2026

Copy link
Copy Markdown
Member

🎯 Changes

Configure TypeDoc to omit page titles because tanstack.com renders the title from frontmatter.

✅ Checklist

🚀 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

  • Documentation
    • Updated generated documentation to hide the page title for a cleaner presentation.

@coderabbitai

coderabbitai Bot commented Sep 10, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 81446ee7-23bc-4ffc-b2fa-516e12a56cfc

📥 Commits

Reviewing files that changed from the base of the PR and between 57a855b and 8729f4a.

📒 Files selected for processing (1)
  • typedoc.json

Included review availability: Your plan provides up to 8 included reviews per hour; 6 remain after this review.


📝 Walkthrough

Walkthrough

The pull request adds typedoc.json and sets hidePageTitle to true for generated TypeDoc documentation.

Changes

TypeDoc configuration

Layer / File(s) Summary
Configure generated page titles
typedoc.json
TypeDoc now uses hidePageTitle: true to hide page titles in generated documentation.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~2 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 8729f

This documentation-only change hides duplicate generated page titles without affecting published code.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: disabling generated TypeDoc page titles.
Description check ✅ Passed The description explains the change and motivation, includes the required checklist and release-impact sections, and correctly marks the change as documentation-only. The local test checkbox is not co…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/remove-duplicate-page-headings

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

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

@nx-cloud

nx-cloud Bot commented Sep 10, 2026

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit e0c6206

Command Status Duration Result
nx run-many --target=build --exclude=examples/** ✅ Succeeded 6s View ↗
nx affected --targets=test:sherif,test:knip,tes... ✅ Succeeded 35s View ↗

☁️ Nx Cloud last updated this comment at 2026-09-10 10:59:57 UTC

@github-actions

Copy link
Copy Markdown
Contributor

🚀 Changeset Version Preview

No changeset entries found. Merging this PR will not cause a version bump for any packages.

@pkg-pr-new

pkg-pr-new Bot commented Sep 10, 2026

Copy link
Copy Markdown
More templates

@tanstack/angular-form

npm i https://pkg.pr.new/@tanstack/angular-form@2378

@tanstack/form-core

npm i https://pkg.pr.new/@tanstack/form-core@2378

@tanstack/form-devtools

npm i https://pkg.pr.new/@tanstack/form-devtools@2378

@tanstack/lit-form

npm i https://pkg.pr.new/@tanstack/lit-form@2378

@tanstack/preact-form

npm i https://pkg.pr.new/@tanstack/preact-form@2378

@tanstack/react-form

npm i https://pkg.pr.new/@tanstack/react-form@2378

@tanstack/react-form-devtools

npm i https://pkg.pr.new/@tanstack/react-form-devtools@2378

@tanstack/react-form-nextjs

npm i https://pkg.pr.new/@tanstack/react-form-nextjs@2378

@tanstack/react-form-remix

npm i https://pkg.pr.new/@tanstack/react-form-remix@2378

@tanstack/react-form-start

npm i https://pkg.pr.new/@tanstack/react-form-start@2378

@tanstack/solid-form

npm i https://pkg.pr.new/@tanstack/solid-form@2378

@tanstack/solid-form-devtools

npm i https://pkg.pr.new/@tanstack/solid-form-devtools@2378

@tanstack/svelte-form

npm i https://pkg.pr.new/@tanstack/svelte-form@2378

@tanstack/vue-form

npm i https://pkg.pr.new/@tanstack/vue-form@2378

commit: 8729f4a

@KevinVandy KevinVandy changed the title docs: remove duplicate page headings docs: disable generated page titles Sep 10, 2026
@KevinVandy
KevinVandy marked this pull request as ready for review September 15, 2026 16:06
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.

1 participant