This project serves as the marketing and documentation hub for all TanStack projects, built using TanStack Router and deployed via Netlify. It provides developers with a centralized, up-to-date resource for understanding and utilizing the TanStack ecosystem, streamlining the documentation contribution process.

How It Works

The site leverages TanStack Router for its internal routing and architecture, with Netlify handling automated deployments. In production, documentation markdown files are dynamically fetched from the respective GitHub repositories of each TanStack project. For local development, these markdown files are read directly from the local filesystem, enabling developers to easily edit and preview documentation changes in real-time.

Quick Start & Requirements

• Install: pnpm install
• Run Dev: pnpm dev (runs on https://localhost:3000 by default)
• Authentication: pnpm auth:login to authenticate local sessions using production OAuth credentials, saving a session token to .env.local. This token expires in 30 days.
• Prerequisites: pnpm package manager.
• Local Docs Editing: Requires cloning tanstack.com and target project repos into a tanstack/ directory structure (e.g., tanstack/form/, tanstack/tanstack.com/).

Highlighted Details

• The site itself is a showcase for TanStack Router.
• Automated deployment pipeline via Netlify.
• Local development environment accurately mirrors production authentication.
• Streamlined workflow for contributing to and previewing documentation for multiple TanStack projects locally.

Maintenance & Community

No specific details regarding maintainers, community channels (e.g., Discord, Slack), or sponsorships are provided in the README.

Licensing & Compatibility

The README does not specify a software license. Compatibility for commercial use or closed-source linking is undetermined without a license.

Limitations & Caveats

Local documentation previews require manual browser reloading. Adding new documentation pages necessitates manual updates to the docs/config.json file. Development session tokens expire every 30 days, requiring re-authentication. The project's license is not specified.