docs: migrate to Fumadocs with AI features#1680
Open
pcriadoperez wants to merge 4 commits intosammchardy:masterfrom
Open
docs: migrate to Fumadocs with AI features#1680pcriadoperez wants to merge 4 commits intosammchardy:masterfrom
pcriadoperez wants to merge 4 commits intosammchardy:masterfrom
Conversation
Replace the legacy Sphinx/RST documentation with a modern Fumadocs (Next.js) site featuring auto-generated API reference, AI chat, and LLM-readable outputs. - Scaffold Fumadocs with Next.js 16, Tailwind CSS 4, MDX content - Convert all 16 RST files to 18 MDX guide pages - Auto-generate 50 API reference pages from Python docstrings via griffe/fumadocs-python - Add llms.txt, llms-full.txt, and per-page .mdx endpoints for AI agents - Add Ask AI chat (OpenRouter) with streaming responses - Add per-page "Copy as Markdown" and "Open with..." (Claude, ChatGPT, Scira, Cursor, GitHub) - Add LLM Integration page with agent skill install instructions and copy buttons - Deploy to Vercel at python-binancedocs.vercel.app
- Move all Fumadocs files (app/, components/, content/, lib/, scripts/, config files) into docs/ subdirectory - Remove old Sphinx RST files, conf.py, Makefile, requirements.txt - Remove .readthedocs.yaml - Update GitHub source links to reflect new paths
- Fix whitespace and indentation issues in client.py, helpers.py, code-generator.py, and depth_cache_threaded_example.py - Restore .readthedocs.yaml (keep RTD alongside new Fumadocs)
- Restrict ruff to core E/W/F rules via lint.select in pyproject.toml - Auto-fix 983 whitespace/formatting errors (W293, E301, E303, etc.) - All checks pass with ruff check --target-version=py39
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Applies lint fixes to examples and tests
Migrate documentation Fumadocs (Next.js + MDX)
Auto-generate API reference from Python docstrings (50 pages via griffe/fumadocs-python)
Convert all 16 RST guide files to 18 MDX pages
Add AI features: llms.txt, llms-full.txt, per-page .mdx endpoints, Ask AI chat (OpenRouter), "Open in Claude/ChatGPT/Cursor" buttons
Add LLM Integration page with agent skill install instructions
Deploy to Vercel at https://python-binancedocs.vercel.app
How to test