| @@ -1,16 +1,16 @@ | ||
| 1 | -=== BetterDocs – AI Documentation, Knowledge Base, Docs, Wikis, FAQ with Chatbot === | |
| 1 | +=== BetterDocs – AI Documentation, Knowledge Base, MCP Server, Docs, Wikis, FAQ & Chatbot === | |
| 2 | 2 | Contributors: wpdevteam, re_enter_rupok, asif2bd, emsohel, priyomukul, seakashdiu, jamilbd07 |
| 3 | 3 | Donate link: https://wpdeveloper.com |
| 4 | 4 | Tags: docs, documentation, knowledge base, faq, chatgpt ai writer |
| 5 | 5 | Requires at least: 6.4 |
| 6 | -Tested up to: 7.0 | |
| 6 | +Tested up to: 7.1 | |
| 7 | 7 | Requires PHP: 7.4 |
| 8 | -Stable tag: 4.8.1 | |
| 8 | +Stable tag: 4.9.5 | |
| 9 | 9 | License: GPLv3 or later |
| 10 | 10 | License URI: http://www.gnu.org/licenses/gpl-3.0.html |
| 11 | 11 | |
| 12 | -Documentation, FAQ & Knowledge Base plugin to create docs, FAQs, product FAQ, wikis & help center with AI writing, instant answers & AI Chatbot. | |
| 12 | +Documentation, FAQ & Knowledge Base plugin to create docs, FAQs, product FAQ, wikis & help center with MCP, AI writing, instant answers & AI Chatbot. | |
| 13 | 13 | == Description == |
| 14 | 14 | |
| 15 | 15 | Do you want to reduce support tickets immediately? How about you creating a resourceful knowledge base for your customers with AI-powered documentation and FAQs? 🤔 |
| 16 | 16 | |
| @@ -35,8 +35,9 @@ | ||
| 35 | 35 | - In-built theme customization option, or use Shortcodes & Elementor widgets, or Gutenberg Blocks to design & customize the entire documentation page |
| 36 | 36 | - Table of Contents or Sticky TOC to provide an absolute user experience |
| 37 | 37 | - An in-built advanced live search bar to help visitors get the exact docs solution |
| 38 | 38 | - Advanced List View & Drag & Drop Grid View feature |
| 39 | +- Connect AI assistants like Claude, ChatGPT, and Cursor to your documentation via MCP with a simple OAuth-based setup — no coding or manual API configuration required | |
| 39 | 40 | - Create & manage multiple knowledge bases for all products separately (PRO) |
| 40 | 41 | - Manage roles for your knowledgebase users & give access accordingly |
| 41 | 42 | - Integrated with Analytics to track and evaluate the performance |
| 42 | 43 | - 100% Compatibility with Elementor Page Builder |
| @@ -75,8 +76,12 @@ | ||
| 75 | 76 | ## ✅ FULL SITE EDITOR (FSE) COMPATIBILITY ## |
| 76 | 77 | |
| 77 | 78 | Design your documentation, single docs, and archive pages effortlessly in the Block Editor using BetterDocs. |
| 78 | 79 | |
| 80 | +## 🛠️ AI-NATIVE DOCUMENTATION ACCESS WITH MCP ## | |
| 81 | + | |
| 82 | +Let AI assistants like Claude, ChatGPT, and Cursor read and write your documentation directly through the Model Context Protocol, so your team can create, update, and manage docs from chat instead of switching between tools. | |
| 83 | + | |
| 79 | 84 | ## 📋 INTERACTIVE TABLE OF CONTENTS (TOC) ## |
| 80 | 85 | |
| 81 | 86 | Create a reader-friendly [Table Of Contents(TOC)](https://wpdeveloper.com/display-toc-wordpress/) while you are writing your documentation. This TOC moves with your scroll, so your visitors can always go to other pages easily. |
| 82 | 87 | |
| @@ -193,8 +198,41 @@ | ||
| 193 | 198 | |
| 194 | 199 | Visit [WPDeveloper](https://wpdeveloper.com) to learn more about how to do better in WordPress with [Help Tutorial, Tips & Tricks](https://wpdeveloper.com/blog)! |
| 195 | 200 | |
| 196 | 201 | |
| 202 | +== External services == | |
| 203 | + | |
| 204 | +BetterDocs works without contacting any outside service. The services below are only contacted after you opt in, enter your own API key, or click the feature that needs them. | |
| 205 | + | |
| 206 | +**Usage tracking (WPInsight, by WPDeveloper)** | |
| 207 | +Only if you click "Sure, I'd like to help" on the opt-in notice. Once a day, it sends your site URL, the email of the admin who opted in, WordPress and PHP versions, active theme and plugins, and BetterDocs usage counts to `send.wpinsight.com`. It also sends your public IP to `ip-api.com` to look up the country. | |
| 208 | +WPDeveloper: [Terms](https://wpdeveloper.com/terms-and-conditions/), [Privacy Policy](https://wpdeveloper.com/privacy-policy/). ip-api.com: [Terms and Privacy](https://ip-api.com/docs/legal). | |
| 209 | + | |
| 210 | +**AI Sample Docs (BetterDocs AI service, `api.betterdocs.co`)** | |
| 211 | +Only when you click "Generate" in AI Sample Docs. It sends your site name, tagline, URL, short excerpts from your pages, posts and products, and your BetterDocs Pro license key (if any), and gets back draft docs. | |
| 212 | +[Terms](https://betterdocs.co/terms-conditions/), [Privacy Policy](https://wpdeveloper.com/privacy-policy/). | |
| 213 | + | |
| 214 | +**Elementor template library (`betterdocs.co`)** | |
| 215 | +Only when you open the BetterDocs templates in Elementor's template library. It requests the template list and the template you insert; your site URL is sent as part of the request. | |
| 216 | +[Terms](https://betterdocs.co/terms-conditions/), [Privacy Policy](https://wpdeveloper.com/privacy-policy/). | |
| 217 | + | |
| 218 | +**AI providers (OpenAI, Anthropic, Google Gemini, OpenRouter, DeepSeek)** | |
| 219 | +Only for the provider you configure with your own API key, and only when an AI feature runs (Write with AI, AI editing, article summaries, FAQ generation and similar). It sends the prompt and the doc content the feature works on. | |
| 220 | +- OpenAI (`api.openai.com`): [Terms](https://openai.com/policies/terms-of-use/), [Privacy Policy](https://openai.com/policies/privacy-policy/) | |
| 221 | +- Anthropic (`api.anthropic.com`): [Terms](https://www.anthropic.com/legal/commercial-terms), [Privacy Policy](https://www.anthropic.com/legal/privacy) | |
| 222 | +- Google Gemini (`generativelanguage.googleapis.com`): [Terms](https://ai.google.dev/gemini-api/terms), [Privacy Policy](https://policies.google.com/privacy) | |
| 223 | +- OpenRouter (`openrouter.ai`): [Terms](https://openrouter.ai/terms), [Privacy Policy](https://openrouter.ai/privacy) | |
| 224 | +- DeepSeek (`api.deepseek.com`): [Terms](https://cdn.deepseek.com/policies/en-US/deepseek-terms-of-use.html), [Privacy Policy](https://cdn.deepseek.com/policies/en-US/deepseek-privacy-policy.html) | |
| 225 | + | |
| 226 | +**Help Scout migration (`docsapi.helpscout.net`)** | |
| 227 | +Only when you enter your Help Scout API key and run the migration. It sends your key to read your Help Scout Docs collections, categories and articles. | |
| 228 | +[Terms](https://www.helpscout.com/company/legal/terms-of-service/), [Privacy Policy](https://www.helpscout.com/company/legal/privacy/). | |
| 229 | + | |
| 230 | +**Google Analytics 4 (`googletagmanager.com`)** | |
| 231 | +Only if a GA4 Measurement ID is set. The standard GA4 tag is loaded on doc pages and sends page views to Google. | |
| 232 | +[Terms](https://marketingplatform.google.com/about/analytics/terms/us/), [Privacy Policy](https://policies.google.com/privacy). | |
| 233 | + | |
| 234 | + | |
| 197 | 235 | == Installation == |
| 198 | 236 | |
| 199 | 237 | = Modern Way: = |
| 200 | 238 | 1. Go to the WordPress Dashboard "Add New Plugin" section. |
| @@ -239,13 +277,92 @@ | ||
| 239 | 277 | |
| 240 | 278 | = Is BetterDocs useful for multilingual documentation? = |
| 241 | 279 | Yes. BetterDocs supports multilingual documentation workflows and integrates with multilingual tools such as WPML, helping you create knowledge base content for users in different languages. |
| 242 | 280 | |
| 281 | += Can I connect ChatGPT or Claude to my documentation? = | |
| 282 | +Yes. BetterDocs includes an MCP server, which lets AI assistants such as Claude, ChatGPT, Cursor and VS Code work with your documentation directly. Turn it on under BetterDocs → MCP, copy the connection URL, and add it to your assistant — it will ask you to approve the connection on your own site. | |
| 283 | + | |
| 243 | 284 | == Screenshots == |
| 244 | 285 | |
| 245 | 286 | |
| 246 | 287 | |
| 247 | 288 | == Changelog == |
| 289 | + | |
| 290 | += 4.9.5 - 12/10/2026 = | |
| 291 | + | |
| 292 | +- Few minor bug fixes & improvements | |
| 293 | + | |
| 294 | += 4.9.4 - 08/10/2026 = | |
| 295 | + | |
| 296 | +- New: Write with AI now accepts audio and video attachments — drop in a Loom, a Zoom recording or a voice note and BetterDocs transcribes it, lets you correct the transcript, then writes the doc from it. Up to 25 MB, using your own OpenAI or Gemini key | |
| 297 | +- New: Listen — a pill beside reading time that reads the article aloud in the reader's browser, with play, pause, seek and speed controls. Enable it under Settings → Layout → Single Doc → Listen; it also ships in the Reading Time block and Elementor widget, and as the [betterdocs_listen] shortcode | |
| 298 | +- New: Animated GIFs in docs are served as a looping, muted video instead of a GIF, cutting page weight substantially, with an editor UI to link an MP4 and a poster image to an existing GIF | |
| 299 | +- New: AI Actions — a "Copy page" button in the single doc meta row that copies the article as clean Markdown, or opens it in ChatGPT, Claude, Google AI Studio, Perplexity or Grok with the page as context. Every doc is also published as Markdown at <doc-url>.md so AI assistants can read it. Enabled by default; configure under Settings → Layout → Single Doc → AI Actions, with full Customizer styling including Icon Color. On block themes and with Elementor Theme Builder it ships inside the "Reading Time, Listen and AI Action" block and widget, and the [betterdocs_ai_actions] shortcode places it anywhere | |
| 300 | +- Improvement: Search now ranks exact title matches above older partial matches, instead of sorting ties oldest-first | |
| 301 | +- Improvement: The Category Grid block script now loads only on pages where the block actually renders | |
| 302 | +- Fixed: AI features ignored the AI platform you selected and required an OpenAI key regardless | |
| 303 | +- Fixed: A site could crash when the AI Chatbot loaded before BetterDocs and Pro loaded after it | |
| 304 | +- Fixed: Single doc URLs returned 200 instead of a proper 404 on WPML sites | |
| 305 | +- Fixed: Table of contents, search box and search form could overflow the page on phones, scrolling the page sideways | |
| 306 | +- Fixed: Single Doc Layout 7 scrolled sideways at 360px, and the reactions box overflowed on phones | |
| 307 | +- Fixed: A collapsible table of contents placed on a regular page could not be expanded on phones | |
| 308 | +- Fixed: The doc sidebar shifted after page load, and sidebar items could stack incorrectly | |
| 309 | +- Fixed: Synced patterns containing BetterDocs blocks lost their styling on most pages, and stale Essential Blocks CSS kept loading in the widget stylesheet on every page | |
| 310 | +- Fixed: GIFs served as video ignored the Image block's size and styles, lost "Expand on click", stayed frozen with no controls when the browser blocked autoplay, and rendered as an empty box when linked to a non-video attachment | |
| 311 | +- Fixed: The REST API and RSS feed returned video markup for converted GIFs | |
| 312 | +- Few minor bug fixes and improvements | |
| 313 | + | |
| 314 | += 4.9.3 - 27/09/2026 = | |
| 315 | + | |
| 316 | +- New: AI Actions — a "Copy page" button in the single doc meta row that copies the article as clean Markdown, or opens it in ChatGPT, Claude, Google AI Studio, Perplexity or Grok with the page as context. Every doc is also published as Markdown at <doc-url>.md so AI assistants can read it. Enabled by default; configure under Settings → Layout → Single Doc → AI Actions. On block themes and with Elementor Theme Builder it ships inside the "Reading Time and AI Action" block and widget, and the [betterdocs_ai_actions] shortcode places it anywhere | |
| 317 | +- Fixed: Doc URLs that do not exist now return a proper 404 instead of an empty page, on sites using category-in-path permalinks | |
| 318 | +- Fixed: Live search returned no results when the knowledge base is served from a subdomain or a domain alias | |
| 319 | +- Fixed: Single Doc Layout 5 no longer shows Table of Contents Background, Hover and Padding controls that had no effect on the page | |
| 320 | +- Fixed: Encyclopedia entries are now listed alphabetically within each letter, instead of newest first | |
| 321 | +- Fixed: MCP OAuth discovery could answer for — or be answered by — another MCP-enabled plugin on the same site, so connecting clients were handed metadata for the wrong plugin | |
| 322 | +- Few minor bug fixes and improvements | |
| 323 | + | |
| 324 | += 4.9.2 - 16/09/2026 = | |
| 325 | + | |
| 326 | +- Fixed: Customizer layout migration seeded the wrong defaults, so saved layouts reverted to Layout 1 | |
| 327 | +- Fixed: Nested subcategories could be cached while empty and stay empty until the cache expired | |
| 328 | +- Fixed: Term counts were not refreshed after a recount, and an aborted import left counts stale | |
| 329 | +- Fixed: Category grids now collapse to a single column below 500px | |
| 330 | +- Fixed: FAQ group titles can now have their own background color | |
| 331 | +- Few minor bug fixes and improvements | |
| 332 | + | |
| 333 | += 4.9.1 - 03/09/2026 = | |
| 334 | + | |
| 335 | +- New: Print template — add your logo and a custom footer to printed / PDF pages, from Settings → Layout → Single Doc | |
| 336 | +- Improvement: Glossaries now show a preview in Free, so you can see what the Pro feature does before upgrading | |
| 337 | +- Improvement: MCP catalogue now surfaces Pro's API Docs, insights, Git Sync and related-docs abilities; connection self-test no longer flags healthy endpoints as broken | |
| 338 | +- Fixed: The Documentation grid hid knowledge bases containing only private docs from admins and editors | |
| 339 | +- Fixed: Doc Category Archive layouts 2 and 3 never rendered nested subcategories | |
| 340 | +- Fixed: "Lazy Load Sidebar Docs & Subcategories" now works for nested categories across both Elementor and block layouts | |
| 341 | +- Fixed: Single doc URLs with arbitrary category segments returned 200 instead of redirecting to the real permalink | |
| 342 | +- Fixed: Importing docs failed with a critical error on exported XML files and on docs with existing slugs | |
| 343 | +- Fixed: The AI Content Suite showed "undefined" / "[object Object]" instead of a readable message when the API key is invalid | |
| 344 | +- Improved: Security Enhancement | |
| 345 | +- Few minor bug fixes and improvements | |
| 346 | + | |
| 347 | += 4.9.0 - 27/08/2026 = | |
| 348 | + | |
| 349 | +- New: MCP Server — connect Claude, Cursor, VS Code and other MCP-capable editors directly to your knowledge base over a per-site endpoint, with OAuth 2.1 consent, pairing tokens and rate limiting | |
| 350 | +- New: BetterDocs registers its docs, categories, tags, glossary, FAQ, settings and analytics with the WordPress Abilities API, so any Abilities-aware tool can read and write your knowledge base | |
| 351 | +- New: MCP admin page with a connection health report, self-test, per-tool picker and ready-made setup snippets for each supported editor | |
| 352 | +- Improvement: Knowledge base meta is now visible over REST, and the FAQ Builder capability check repairs itself when roles drift | |
| 353 | +- Fix: Document import no longer fails on PHP 8 — WP_Importer has no constructor, and calling it aborted every import | |
| 354 | +- Fix: The FAQ block now accepts bare term IDs in its group filters | |
| 355 | +- Few minor bug fixes and improvements | |
| 356 | + | |
| 357 | += 4.8.2 - 20/08/2026 = | |
| 358 | + | |
| 359 | +- New: Code Snippet Tab — a tabbed, multi-language code block available as both a Gutenberg block and an Elementor widget | |
| 360 | +- New: Write with AI can now draft from an uploaded file (TXT, MD, DOCX, PDF) or read image attachments (PNG, JPG, WEBP) using a vision model | |
| 361 | +- Improvement: Code Snippet block, Elementor widget & shortcode now support multiple languages with a built-in language switcher and self-hosted syntax highlighting (no external requests) | |
| 362 | +- Improvement: Content Area Width & Max Width controls for the single doc layout in the Customizer | |
| 363 | +- Improved: Security Enhancement | |
| 364 | +- Few minor bug fixes and improvements | |
| 248 | 365 | |
| 249 | 366 | = 4.8.1 - 04/08/2026 = |
| 250 | 367 | |
| 251 | 368 | - Few minor bug fixes and improvements |
