Skip to content

Conversation

@SeanCassiere
Copy link
Member

@SeanCassiere SeanCassiere commented May 20, 2025

Redo of #396 with the new changes available using the features in the TanStack Start Alpha channel.


Updated description from #396.

This is a POC PR that lets the user to access the markdown documentation pages by adding .md to the end of the path.

  • /form/latest/docs/framework/react/guides/basic-concepts.md serves the markdown version of the documentation page.

Why is it useful?

This feature is useful for using the documentation with LLMs, and was inspired by vite:

For every page you can get the original markdown by replacing the .html extension with .md - e.g.:

https://vite.dev/guide/rolldown
(Posted by Evan You)

This feature would let the user to pass the documentation pages as context to the LLM-s they use for specific versions of tanstack libs, which would make sure that they always get the right information, even if there were breaking changes between versions.

SeanCassiere and others added 2 commits May 20, 2025 16:05
Co-Authored-By: fuko <43729152+fulopkovacs@users.noreply.github.com>
@netlify
Copy link

netlify bot commented May 20, 2025

Deploy Preview for tanstack ready!

Name Link
🔨 Latest commit 5807d4e
🔍 Latest deploy log https://app.netlify.com/projects/tanstack/deploys/682c0cdfcfc54900084874a2
😎 Deploy Preview https://deploy-preview-413--tanstack.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 33 (🔴 down 17 from production)
Accessibility: 95 (no change from production)
Best Practices: 83 (🔴 down 9 from production)
SEO: 77 (no change from production)
PWA: 60 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

Co-Authored-By: fuko <43729152+fulopkovacs@users.noreply.github.com>
@SeanCassiere SeanCassiere deleted the pr-396-redo branch May 20, 2025 11:18
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