Skip to content

Add LLM Integration to Documentation with Dropdown Menu #1232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

bz-hashtag-0780
Copy link
Collaborator

Add LLM Integration to Documentation with Dropdown Menu

This PR adds a comprehensive set of LLM integration features to our documentation to enablw users to easily interact with our docs through AI assistants like ChatGPT and Claude

Features

1. New PageActionsDropdown Component

  • Added a new dropdown menu in the documentation UI
  • Implemented with accessibility in mind using portals for proper layering
  • Responsive design that works across different screen sizes

2. Four LLM Integration Options:

  • Copy page as Markdown for LLMs
  • View as Markdown
  • Open in ChatGPT - Direct link to ChatGPT with a pre-populated prompt
  • Open in Claude - Direct link to Claude with a pre-populated prompt

3. Markdown Generation

  • scripts/generate-llm-files.js to generate static Markdown files in /static/markdown/ - This preserves proper Markdown formatting including frontmatter, headings, lists, code blocks

Benefits

  • Improves documentation experience for AI-assisted workflows
  • Makes content more accessible to AI tools and users
  • Enables users to ask questions about documentation more efficiently
  • Provides consistent formatting when sharing content with LLMs

had to create static markdown pages to make it work properly
Copy link

vercel bot commented Apr 22, 2025

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

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 22, 2025 8:35pm

Copy link
Contributor

@briandoyle81 briandoyle81 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there's a way to do this without adding the markdown files

@Aliserag Aliserag requested a review from briandoyle81 April 24, 2025 18:42
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