Yukdigitalz Knowledge Base

وضاحت

Yukdigitalz Knowledge Base is a lightweight, secure, and accessible documentation plugin for WordPress. Designed for enterprise-level performance and premium modern aesthetics, it provides a seamless repository-ready system to publish, manage, and interact with your technical resources.

In addition to traditional Knowledge Base grids and navigation, Yukdigitalz Knowledge Base is equipped with a state-of-the-art RAG AI Chat Assistant drawer (SaaS style). The AI assistant utilizes Retrieval-Augmented Generation (RAG) to scan your published articles, retrieve matching context, and reply contextually. It leverages the native WordPress AI Client. To protect your server from quota exhaustion, it features robust Hashed IP Rate Limiting and client-side anti-spam cooldown mechanisms.

Features

  • SaaS-Style AI Chat Assistant (RAG): A floating spark button slides out a contextual chat drawer. The assistant automatically queries the knowledge base (yukdigitalz_kb_doc), inserts matching content records as context, and replies contextually using AI.
  • WordPress Native AI Client: Seamlessly hooks into wp_ai_client_prompt to leverage AI options configured in your WP dashboard.
  • AI Chat Rate Limiting & Anti-Spam Security: Built-in privacy-safe hashed IP request tracking via WordPress Transients (limits maximum queries per hour per user) and client-side cooldown locks.
  • Premium Performance Layouts: Built entirely using zero-dependency, modern Vanilla JS and lightweight clean CSS (fully compatible with Gutenberg, Classic Editor, and Block/FSE Themes).
  • AJAX Live Search: Accessible instant searching matching post titles, categories, and article snippets with a loading indicator.
  • Collapsible Accordion Sidebar: Interactive, accessible list of categories and documents in the sidebar that preserves expansion states.
  • Automatic Table of Contents (TOC): Dynamically parses h2 and h3 tags inside article content to render a floating index widget.
  • Helpfulness Feedback Widget: AJAX-based user voting (“Was this article helpful?”) with custom cookie session locks to prevent spam ratings.
  • Video Tutorial Walkthroughs: Dedicated support for YouTube, Vimeo, and oEmbed video guides rendered in a responsive 16:9 player with visual video badges across navigation listings.
  • Breadcrumbs Navigation: Automated microdata-ready hierarchical path links at the top of individual documentation pages.
  • Sequential Article Navigation: Accessible Previous and Next topic navigation cards at the bottom of documentation articles, dynamically sequenced by category and document order.
  • Enterprise Customizer Settings: A premium, tabbed dashboard options page allowing you to configure custom base slugs, primary hover colors, rating widgets, TOCs, Q&A Comments toggle, Article Navigation toggle, and rate limit parameters.

Privacy & Third-Party Services

This plugin supports optional third-party integrations:
* AI Chat Assistant: Powered by the WordPress AI Client. Queries retrieve local documentation snippets to ground responses in facts and are processed by your chosen model (e.g. Gemini, OpenAI, or local models). No personal identifying information (PII) or user credentials are stored. Rate limiting uses one-way SHA-256 hashed IP addresses in WordPress Transients.
* Embedded Video Walkthroughs: When an article includes an optional video guide (such as YouTube or Vimeo), playing the video connects directly to the respective third-party provider’s servers in accordance with their privacy policies.

انسٽاليشن

  1. Upload the plugin files to the /wp-content/plugins/yukdigitalz-knowledge-base directory, or install through the WordPress Plugins dashboard.
  2. Activate the plugin.
  3. Save options under Settings > Yukdigitalz KB in your admin dashboard to flush rewrite rules and initialize custom paths.
  4. Insert the [yukdigitalz_kb] shortcode on any Page to display the main Knowledge Base category grid card portal.
  5. Create categories under Yukdigitalz KB > Categories and write documentation posts.

FAQ

Can I customize the colors to match my brand?

Yes. Navigate to Settings > Yukdigitalz KB > Styling Options to customize primary, hover transition, and accent highlight colors via color pickers.

How does the AI Assistant retrieve information?

When a user asks a question, the plugin performs an internal WP_Query search on the custom post type yukdigitalz_kb_doc. The top 3 matching articles are retrieved and supplied directly to your configured WordPress AI Client as ground-truth context.

Can I override templates in my child theme?

Yes. Copy any template file from the plugin’s templates/ folder and paste it into a yukdigitalz-kb/ folder inside your active theme directory to override layouts safely.

جائزا

ھن پلگ ان لاءِ ڪي به رايا ناھن.

تعاون ڪندڙ & ڊولپرز

“Yukdigitalz Knowledge Base” اوپن سورس سافٽ ويئر آهي. ھيٺين ماڻھن ھن پلگ ان ۾ حصو ورتو آھي.

تعاون ڪندڙ

ترجمو ڪريو “Yukdigitalz Knowledge Base” توهان جي ٻولي ۾.

ڊولپمينٽ ۾ دلچسپي؟

ڪوڊ براؤز ڪريو، چيڪ ڪريو SVN مخزن، يا رڪنيت حاصل ڪريو ڊولپمينٽ لاگ پاران RSS.

لاگ تبدیل ڪريو

1.2.0

  • Added Video Tutorial Documentation feature: dedicated Video Walkthrough meta box for YouTube, Vimeo, and WordPress oEmbed links.
  • Added responsive 16:9 enterprise-grade video player container above article content.
  • Added visual Video Guide indicator badges in the sidebar accordion, category archive cards, and portal grid.
  • Added Sequential Article Navigation (Previous / Next) with 2-column responsive cards ordered within the same category.
  • Added admin setting toggle for Sequential Article Navigation in Settings > Features.
  • Added developer action hook yukdigitalz_kb_after_video_player for video player extensions.
  • Added third-party embedded video privacy disclosure in compliance with WordPress.org guidelines.
  • Fixed mobile responsive horizontal overflow by enforcing min-width: 0 truncation on card titles and adding overflow-x containment.
  • Improved multi-tier responsive breakpoints (768px, 640px, 480px) and responsive wrapping for pagination buttons.
  • Enhanced input sanitization and unslashing for video URLs and AJAX parameters to strictly satisfy WordPress.org Plugin Check standards.

1.1.2

  • Fixed mobile Ask AI floating trigger to prevent visual collisions with third-party chat widgets.
  • Elevated Ask AI chat drawer directly to body stacking context to stay above third-party floating buttons.

1.1.1

  • Fixed Ask AI modal buttons and floating trigger styling isolation against active WordPress theme CSS overrides.

1.1.0

  • Added Smart Category Templates: Parent Category Product Showcase Directory Grid vs Child Category Documentation Hub.
  • Enhanced hierarchical permalink structure (domain/docs/{category}/{guide}) with seamless multi-level ancestor support.
  • Added automated 301 canonical & legacy redirect for backward compatibility.
  • Fixed sidebar accordion toggle so clicking anywhere on category text or chevron opens the sub-list instantly without page reload.
  • Fixed empty category exclusion on knowledge base portal by displaying newly created categories immediately.
  • Fixed 404 error on nested subcategory routing.
  • Fixed shadow mode on single article page.

1.0.0

  • Initial release.
  • Added hierarchical CPT and taxonomy registration.
  • Added AJAX Live Search, helpfulness rating, and automatic Table of Contents.
  • Added SaaS-style right-side slide-over RAG AI Chat Assistant drawer.
  • Added hashed IP rate limiting and 2-second anti-spam cooldown lock to the AI Chat.