WP Manifestindependent plugin directory
manifest / ai / wp-intelligent-code-assistant

WP Intelligent Code Assistant

An interactive code block with inline AI assistance for technical articles, powered by the WordPress AI Client, Abilities API and Interactivity API.

★ 0stars

Install

Download source zip No release zip yet

This is the repository archive. It installs, but the folder name will carry the branch suffix and updates will not flow.

Install straight from GitHub with WP-CLI:

wp plugin install https://github.com/michael-bertram/wp-intelligent-code-assistant/archive/refs/heads/main.zip
Updates itself. It ships its own updater, so new versions appear under Dashboard → Updates.

WP Intelligent Code Assistant is an experimental WordPress plugin that turns technical code examples into contextual, AI-assisted learning experiences and turns reader interactions into useful editorial signals.

The project explores a WordPress-native approach to AI integration: WordPress owns the content, context, capabilities and deterministic data, while the configured AI connection is used for generation and interpretation. Readers can get help without leaving the tutorial or manually recreating its context in an external AI tool.

What it does

Reader-facing Code Assistant

Intelligent Code examples can expose four contextual AI tools:

  • Explain Code — explains the active example in the context of the tutorial.
  • Explain This Line — explains a selected line together with its surrounding code.
  • Ask about this code — lets the reader ask their own question about the active example.
  • Check Your Understanding — creates an in-context knowledge check.

A shared floating Code Assistant follows the reader's active code example rather than attaching a separate AI interface to every block. The active example and nearby tutorial content are supplied as context so the assistance can be grounded in what the reader is currently learning.

Tutorial-aware context

The assistant does not send code in isolation. Shared context can include the active code, language, filename, example title, tutorial title, nearby teaching content and capability-specific information such as the selected line or reader question.

This keeps context construction in WordPress and allows the same AI abilities to be reused across multiple code examples.

Reusable canonical Code Examples

The plugin registers the ica_code_example custom post type for reusable Code Examples.

Each Code Example owns one canonical Intelligent Code block and its code/configuration. Article blocks can reference that canonical example through codeExampleId instead of storing stale copies.

This separates:

  • semantic identity — which Code Example the reader is working with;
  • article context — where and why the snippet is being taught;
  • rendered identity — which particular block instance received the interaction.

A reference resolves the canonical content at render time while the article continues to provide its own tutorial context.

Deterministic Reader Insights

WordPress records known reader actions before AI is asked to interpret them. The analytics model currently supports:

  • explain_code
  • explain_line
  • ask_question
  • knowledge_check
  • mark_complete
  • copy_code

Events retain useful context including the article, Code Snippet, rendered block, filename, language and event-specific metadata.

These figures represent actions/interactions, not unique readers.

The Intelligent Code admin workspace provides:

  • Overview — entry point for Code Snippets and analytics.
  • Reader Insights — article-level deterministic interaction data.
  • Code Example Insights — activity for reusable examples across the articles where they appear.
  • AI Editorial Insights — AI interpretation of server-authoritative analytics to help authors investigate possible reader friction and opportunities to improve content.

Generated reader-facing AI responses are not the analytics source of truth. WordPress records what happened; deterministic code aggregates it; AI helps interpret what it might mean.

Centralised authoring workspace

The Block Editor includes an article-level Code Assistant workspace for managing the AI learning material associated with the article's Code Examples. Authors can review readiness and generate or regenerate predictable material such as Explain Code responses, line explanations and Knowledge Checks before publication. This keeps repeatable teaching content author-controlled rather than generating the same material independently for every reader.

WordPress-native AI architecture

The plugin is designed around WordPress rather than treating AI as a separate application:

  • Gutenberg provides the authoring and reusable-content model.
  • Custom Post Types give Code Snippets stable semantic identities.
  • Interactivity API powers reader-facing interactions.
  • Abilities API exposes reusable, structured capabilities.
  • WordPress AI Client / configured AI connection handles AI generation without coupling the feature to a single provider.
  • Plugin REST endpoints provide the application boundary for frontend requests.
  • WordPress analytics storage and aggregation provide deterministic evidence before AI interpretation.

The plugin also registers AI-assisted metadata generation as a WordPress Ability and exposes appropriate abilities through WordPress's AI/Abilities architecture.

Public AI hardening

The reader-facing Ask about this code capability is deliberately treated as a public endpoint. Requests are bounded and validated before provider execution, cross-site requests are rejected, anonymous requests are rate-limited, and provider failures are normalised at the REST boundary. Questions are limited to 1,000 characters, while code and tutorial context have separate input limits. Explanations and Knowledge Checks are generated during authoring and stored with the Code Example, so they do not require a live provider request for every reader.

The key architectural principle is:

Use deterministic software for what can be known; use AI for what needs to be interpreted.

That allows WordPress and AI to work together natively: WordPress supplies structured content, context and reliable application behaviour, while AI adds generation and interpretation where it is useful.

Content loop

The project connects the reader and editorial experiences:

Author creates structured WordPress content
                    ↓
             Reader engages
                    ↓
        AI provides contextual help
                    ↓
 WordPress records deterministic signals
                    ↓
        Analytics reveal patterns
                    ↓
         AI helps interpret them
                    ↓
       Author improves the content
                    ↺

The reader remains in control of when AI assistance is requested, and the author remains responsible for editorial decisions.

Development

Install dependencies and compile the production assets:

npm install
npm run build

During development:

npm start

Production assets in build/ are intentionally tracked. Rebuild and commit them whenever source assets change.

Project status

This repository is an experimental exploration of native WordPress AI integration and intelligent technical content. It demonstrates how WordPress's existing content and application architecture can work hand in hand with AI without requiring the AI layer to own the underlying content model or analytics.

License

GPL-2.0-or-later.