Skip to content

feat: add Octane framework support - #1088

Merged
KevinVandy merged 1 commit into
mainfrom
agent/add-octane-framework
Aug 1, 2026
Merged

feat: add Octane framework support#1088
KevinVandy merged 1 commit into
mainfrom
agent/add-octane-framework

Conversation

@KevinVandy

@KevinVandy KevinVandy commented Jul 31, 2026

Copy link
Copy Markdown
Member

What changed

  • register Octane as a framework across the site framework metadata
  • advertise Octane support for TanStack Table and TanStack Store only
  • resolve the adapter packages as @tanstack/octane-table and @tanstack/octane-store
  • add the official Octane logo and npm/LLM display metadata
  • support .tsrx example entry points, file icons, and TSX syntax highlighting
  • add coverage that prevents other libraries from accidentally advertising Octane support

Why

TanStack Store and TanStack Table now ship Octane adapters and their docs/examples need to be discoverable and render correctly on tanstack.com. Octane examples use authored .tsrx files, so the example browser also needs to recognize that extension.

Validation

  • pnpm test
  • pnpm build
  • formatting check
  • git diff --check

Summary by CodeRabbit

  • New Features

    • Added Octane framework support for TanStack Table and TanStack Store.
    • Added Octane branding and framework selection throughout the library experience.
    • Added support for .tsrx example files, including file icons and syntax highlighting.
    • Octane examples now default to src/main.tsrx.
  • Tests

    • Added coverage for Octane framework integration, package resolution, file selection, and syntax highlighting.

@coderabbitai

coderabbitai Bot commented Jul 31, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: a4999f8f-84d8-4071-8b4f-06b719aca61b

📥 Commits

Reviewing files that changed from the base of the PR and between ee6f55a and 79c7e50.

⛔ Files ignored due to path filters (1)
  • src/images/octane-logo.svg is excluded by !**/*.svg
📒 Files selected for processing (12)
  • src/components/FileExplorer.tsx
  • src/components/markdown/codeBlock.shared.tsx
  • src/libraries/frameworks.tsx
  • src/libraries/libraries.ts
  • src/libraries/types.ts
  • src/routes/_library/$libraryId/$version.docs.framework.$framework.examples.$.tsx
  • src/utils/llms.ts
  • src/utils/npm-packages.ts
  • src/utils/sandbox.ts
  • tests/code-highlighting.test.ts
  • tests/octane-framework-support.test.ts
  • tests/repo-path.test.ts

📝 Walkthrough

Walkthrough

The change adds Octane as a supported framework for TanStack Table and Store. It registers Octane metadata and adds .tsrx handling for example paths, syntax highlighting, and file icons.

Changes

Octane framework support

Layer / File(s) Summary
Register Octane framework support
src/libraries/types.ts, src/libraries/frameworks.tsx, src/libraries/libraries.ts, src/utils/llms.ts, src/utils/npm-packages.ts
Adds Octane to framework types, display metadata, package metadata, and the supported framework lists for Table and Store.
Handle TSRX example files
src/utils/sandbox.ts, src/routes/_library/..., src/components/FileExplorer.tsx, src/components/markdown/codeBlock.shared.tsx
Uses .tsrx for Octane examples and maps TSRX files to Octane icons and TSX syntax highlighting.
Validate Octane integration
tests/octane-framework-support.test.ts, tests/code-highlighting.test.ts, tests/repo-path.test.ts
Tests framework filtering, package resolution, syntax highlighting, and the default Octane Table example path.

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

Suggested reviewers: tannerlinsley

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: adding Octane framework support.
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 💡 1
📝 Generate docstrings 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch agent/add-octane-framework

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.

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
tanstack-com 79c7e50 Commit Preview URL

Branch Preview URL
Jul 31 2026, 10:57 PM

@KevinVandy
KevinVandy marked this pull request as ready for review July 31, 2026 23:02
@KevinVandy
KevinVandy merged commit 2741b9c into main Aug 1, 2026
7 checks passed
@KevinVandy
KevinVandy deleted the agent/add-octane-framework branch August 1, 2026 02:57
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.

2 participants