Skip to content

docs: disable generated page titles - #360

Merged
KevinVandy merged 5 commits into
mainfrom
docs/remove-duplicate-page-headings
Sep 15, 2026
Merged

KevinVandy merged 5 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
    • Removed redundant generated title headings from API reference pages across supported frameworks and core store documentation.
    • Standardized reference pages to begin with frontmatter followed by signatures, sections, or source details.
    • Existing API signatures, descriptions, examples, and deprecation guidance remain unchanged.
    • Updated documentation generation settings to hide default page titles in future TypeDoc output.

@coderabbitai

coderabbitai Bot commented Sep 10, 2026 •

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 1f6df6e0-8330-4bd3-b1fe-f0b74e9f3338

📥 Commits

Reviewing files that changed from the base of the PR and between 8699e10 and 4165d67.

📒 Files selected for processing (80)
  • docs/framework/angular/reference/functions/createStoreContext.md
  • docs/framework/angular/reference/functions/injectAtom.md
  • docs/framework/angular/reference/functions/injectSelector.md
  • docs/framework/angular/reference/functions/injectStore-1.md
  • docs/framework/angular/reference/functions/injectStore.md
  • docs/framework/angular/reference/index.md
  • docs/framework/angular/reference/interfaces/InjectSelectorOptions.md
  • docs/framework/angular/reference/interfaces/WritableAtomSignal.md
  • docs/framework/angular/reference/type-aliases/SelectionSource.md
  • docs/framework/octane/reference/functions/createStoreContext.md
  • docs/framework/octane/reference/functions/useAtom.md
  • docs/framework/octane/reference/functions/useCreateAtom.md
  • docs/framework/octane/reference/functions/useCreateStore.md
  • docs/framework/octane/reference/functions/useSelector.md
  • docs/framework/octane/reference/index.md
  • docs/framework/octane/reference/interfaces/UseSelectorOptions.md
  • docs/framework/preact/reference/functions/createStoreContext.md
  • docs/framework/preact/reference/functions/useAtom.md
  • docs/framework/preact/reference/functions/useCreateAtom.md
  • docs/framework/preact/reference/functions/useCreateStore.md
  • docs/framework/preact/reference/functions/useSelector.md
  • docs/framework/preact/reference/functions/useStore-1.md
  • docs/framework/preact/reference/functions/useStore.md
  • docs/framework/preact/reference/index.md
  • docs/framework/preact/reference/interfaces/UseSelectorOptions.md
  • docs/framework/react/reference/functions/createStoreContext.md
  • docs/framework/react/reference/functions/useAtom.md
  • docs/framework/react/reference/functions/useCreateAtom.md
  • docs/framework/react/reference/functions/useCreateStore.md
  • docs/framework/react/reference/functions/useSelector.md
  • docs/framework/react/reference/functions/useStore-1.md
  • docs/framework/react/reference/functions/useStore.md
  • docs/framework/react/reference/index.md
  • docs/framework/react/reference/interfaces/UseSelectorOptions.md
  • docs/framework/solid/reference/functions/createStoreContext.md
  • docs/framework/solid/reference/functions/useAtom.md
  • docs/framework/solid/reference/functions/useSelector.md
  • docs/framework/solid/reference/functions/useStore-1.md
  • docs/framework/solid/reference/functions/useStore.md
  • docs/framework/solid/reference/index.md
  • docs/framework/solid/reference/interfaces/UseSelectorOptions.md
  • docs/framework/svelte/reference/functions/useAtom.md
  • docs/framework/svelte/reference/functions/useSelector.md
  • docs/framework/svelte/reference/functions/useStore-1.md
  • docs/framework/svelte/reference/functions/useStore.md
  • docs/framework/svelte/reference/index.md
  • docs/framework/svelte/reference/interfaces/UseSelectorOptions.md
  • docs/framework/vue/reference/functions/useAtom.md
  • docs/framework/vue/reference/functions/useSelector.md
  • docs/framework/vue/reference/functions/useStore-1.md
  • docs/framework/vue/reference/functions/useStore.md
  • docs/framework/vue/reference/index.md
  • docs/framework/vue/reference/interfaces/UseSelectorOptions.md
  • docs/reference/classes/ReadonlyStore.md
  • docs/reference/classes/Store.md
  • docs/reference/functions/batch.md
  • docs/reference/functions/createAsyncAtom.md
  • docs/reference/functions/createAtom.md
  • docs/reference/functions/createStore.md
  • docs/reference/functions/flush.md
  • docs/reference/functions/shallow.md
  • docs/reference/functions/toObserver.md
  • docs/reference/index.md
  • docs/reference/interfaces/Atom.md
  • docs/reference/interfaces/AtomOptions.md
  • docs/reference/interfaces/BaseAtom.md
  • docs/reference/interfaces/InternalBaseAtom.md
  • docs/reference/interfaces/InternalReadonlyAtom.md
  • docs/reference/interfaces/InteropSubscribable.md
  • docs/reference/interfaces/Readable.md
  • docs/reference/interfaces/ReadonlyAtom.md
  • docs/reference/interfaces/Subscribable.md
  • docs/reference/interfaces/Subscription.md
  • docs/reference/type-aliases/AnyAtom.md
  • docs/reference/type-aliases/Observer.md
  • docs/reference/type-aliases/Selection.md
  • docs/reference/type-aliases/StoreAction.md
  • docs/reference/type-aliases/StoreActionMap.md
  • docs/reference/type-aliases/StoreActionsFactory.md
  • typedoc.json

📝 Walkthrough

Walkthrough

The change enables TypeDoc to hide generated page titles and removes redundant H1 headings from core and framework reference documentation. API signatures and remaining documentation content are unchanged.

Changes

Generated reference title cleanup

Layer / File(s) Summary
TypeDoc title configuration
typedoc.json
TypeDoc now sets hidePageTitle to true.
Core reference pages
docs/reference/classes/*, docs/reference/functions/*, docs/reference/interfaces/*, docs/reference/type-aliases/*, docs/reference/index.md
Generated H1 headings are removed from core reference pages.
Framework reference pages
docs/framework/*/reference/**
Generated H1 headings are removed from Angular, Octane, Preact, React, Solid, Svelte, and Vue reference pages.

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

Change: Other

✨ 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 19480d4

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

☁️ Nx Cloud last updated this comment at 2026-09-10 11:00:42 UTC

@pkg-pr-new

pkg-pr-new Bot commented Sep 10, 2026 •

Copy link
Copy Markdown
@tanstack/angular-store

npm i https://pkg.pr.new/@tanstack/angular-store@360

@tanstack/lit-store

npm i https://pkg.pr.new/@tanstack/lit-store@360

@tanstack/octane-store

npm i https://pkg.pr.new/@tanstack/octane-store@360

@tanstack/preact-store

npm i https://pkg.pr.new/@tanstack/preact-store@360

@tanstack/react-store

npm i https://pkg.pr.new/@tanstack/react-store@360

@tanstack/solid-store

npm i https://pkg.pr.new/@tanstack/solid-store@360

@tanstack/store

npm i https://pkg.pr.new/@tanstack/store@360

@tanstack/svelte-store

npm i https://pkg.pr.new/@tanstack/svelte-store@360

@tanstack/vue-store

npm i https://pkg.pr.new/@tanstack/vue-store@360

commit: 4165d67

@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:05
@KevinVandy
KevinVandy merged commit ade5663 into main Sep 15, 2026
8 of 9 checks passed
@KevinVandy
KevinVandy deleted the docs/remove-duplicate-page-headings branch September 15, 2026 16:05
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