[DOC] Docs Polish 07/2025

[itaismith]

Description of changes

• Fix TOC UI bug. It should have the same width on all pages and not overflow the width of the screen.
• Add persistent scroll position for the sidebar. When going to a new page the sidebar should retain its previous scroll position for the same section.
• Add getting started video.
• Complete SPANN docs.
• Adding llms.txt and llms-full.txt.
• Adding "Ask AI" button. On s-lg screens it's set near the page tittle; on xl and beyond it is above the TOC.
• To support good results with ChatGPT and Claude, we need to expose .txt files for all docs pages.
• Adding .txt files for all docs pages to support "Ask AI".
• Adding a generate-llms-txt script to generate the files above.

[github-actions]

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

• Can you think of any use case in which the code does not behave as intended? Have they been tested?
• Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
• If appropriate, are there adequate property based tests?
• If appropriate, are there adequate unit tests?
• Should any logging, debugging, tracing information be added or removed?
• Are error messages user-friendly?
• Have all documentation changes needed been made?
• Have all non-obvious changes been commented?

System Compatibility

• Are there any potential impacts on other parts of the system or backward compatibility?
• Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

• Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

[propel-code-bot]

Docs Overhaul: TOC Fixes, Persistent Sidebars, 'Ask AI', LLM Support, and SPANN Documentation

This PR implements a large-scale update to the documentation site, combining UI/UX improvements, new user-facing features, long-form documentation expansions, and infrastructural changes for LLM compatibility. It redesigns how the Table of Contents is rendered to address width and overflow bugs, introduces a persistent scroll position for the sidebar, adds an "Ask AI" button for instant queries in ChatGPT/Claude (with UI variants by screen size), completes detailed SPANN (vector index) documentation, and augments the docs system by generating and surfacing plain text copies of all documentation pages specifically for LLM consumption. A new script and package updates automate the .txt file generation for future scalability.

Key Changes

• Refactored TOC (Table of Contents) as a new component supporting correct sizing, improved hierarchy, and screen responsiveness.
• Sidebar now stores/restores scroll position for each section using sessionStorage for better navigation continuity.
• Added 'Ask AI' dropdown button-context-sensitive for both OpenAI ChatGPT and Anthropic Claude-visible in-page or above TOC on xl+ screens.
• Inserted a getting started video and finished SPANN documentation, enhancing onboarding and technical depth.
• Automated generation and public serving of .txt files for all docs pages (and index lists) to enable robust LLM Q&A support.
• Updated UI layout, fixed multiple minor issues around prose/outline/page elements.
• New script (generate-llms-txts.ts) and dependencies for automated TXT generation.
• Refactoring: removed legacy front matter from Markdown, improved separation of concerns in layout/TOC/sidebar.

Affected Areas

• Docs site UI: Table of Contents, Sidebar, MarkdocRenderer, SidebarToggle
• Docs content: getting-started.md, SPANN docs, about.md, introduction.md, etc.
• Documentation system: new 'public/llms' TXT files and related scripts
• User-facing onboarding (videos), and command documentation (.txt)
• Package JSON: scripts, dependencies

This summary was automatically generated by @propel-code-bot

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
chroma	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 6, 2025 6:25pm