AI Powered Summary

PinkDocs automatically generates an AI-powered summary for each document and displays it above the content. The same summary is also used by the Ask AI assistant to provide instant context before users ask questions.

How to Enable AI-Powered Summary

Location: PinkDocs → Plugin Settings → AI Features

1. Make sure your OpenAI API Key is added
2. Toggle AI-Powered Summary to ON
3. Click Save Settings

Once enabled, summaries are generated automatically.

How It Works

1. When a document is opened, PinkDocs checks if an AI summary already exists
2. If a summary is found, it is displayed instantly
3. If not, AI generates a new summary from the document content
4. The summary is saved and reused for future visits

This ensures summaries are generated only once per document.

Ask AI Integration

• The generated summary is reused inside the AI Assistant as Document Summary
• Users get immediate context without reading the full page
• Clicking Ask AI continues the conversation using the summarized content
• This makes AI responses faster and more accurate

Smart Caching (Performance Optimized)

Cache Key

_pinkdocs_ai_summary

Storage

• Stored as post meta for each document

Persistence

• Permanent
• Remains cached until:
  • The document is updated, or
  • The post meta is manually deleted

Caching Behavior

• Cached summary exists → No OpenAI API call
• No cached summary → Generate once and cache
• Document updated → Summary regenerates automatically

Why Caching Matters

• Faster page loads
• Reduced OpenAI API usage and cost
• Same summary reused across UI and AI Assistant
• Scales efficiently for large documentation sites

Benefits for Users

• Instantly understand long documents
• Clear overview before diving deeper
• Seamless transition from reading to asking AI

Benefits for Site Owners

• No manual summary writing
• Predictable AI usage
• Better performance at scale
• Works automatically once enabled

The AI-Powered Summary in PinkDocs is designed to be fast, cached, and reusable, delivering clarity to users while keeping performance and costs under control.