Display setup instructions from README in plugin for each AI service provider

includes/Classifai/Admin/Settings.php

@@ -171,6 +171,7 @@ public function get_features( bool $with_instance = false ): array {
 					'roles'              => $feature->get_roles(),
 					'enable_description' => $feature->get_enable_description(),
 					'taxonomies'         => $feature->get_taxonomies(),
+					'providers_data'     => $feature->supported_providers_data,
 				);
 
 				// Add taxonomies under post types for language processing features to allow filtering by post type.

includes/Classifai/Features/AudioTranscriptsGeneration.php

@@ -26,6 +26,13 @@
 	 */
 	const ID = 'feature_audio_transcripts_generation';
 
+	/**
+	 * Instruction file name for the feature.
+	 *
+	 * @var string
+	 */
+	public $instruction_file = '08.audio-transcripts-generation.md';
+
 	/**
 	 * Constructor.
 	 */
@@ -40,6 +47,16 @@
 			OpenAISpeechToText::ID     => __( 'OpenAI Audio Transcription', 'classifai' ),
 			ElevenLabsSpeechToText::ID => __( 'ElevenLabs Audio Transcription', 'classifai' ),
 		];
+
+		// Get readme content.
+		$readme_content = $this->get_instruction_content();
+
+		// Contains supported providers data.
+		$this->supported_providers_data = [
+			'instruction' => [
+				SpeechToText::ID => preg_match( '/## Set Up via OpenAI Speech to Text(.*?)(?:\n## |\z)/s', $readme_content, $matches ) ? $matches[1] : '',
+			],
+		];
 	}
 
 	/**

includes/Classifai/Features/Classification.php

@@ -30,6 +30,13 @@ class Classification extends Feature {
 	 */
 	const ID = 'feature_classification';
 
+	/**
+	 * Instruction file name for the feature.
+	 *
+	 * @var string
+	 */
+	public $instruction_file = '01.classification.md';
+
 	/**
 	 * Constructor.
 	 */
@@ -46,6 +53,19 @@ public function __construct() {
 			AzureEmbeddings::ID  => __( 'Azure OpenAI Embeddings', 'classifai' ),
 			OllamaEmbeddings::ID => __( 'Ollama', 'classifai' ),
 		];
+
+		// Get readme content.
+		$readme_content = $this->get_instruction_content();
+
+		// Contains supported providers data.
+		$this->supported_providers_data = [
+			'instruction' => [
+				NLU::ID              => preg_match( '/## Set Up via IBM Watson(.*?)(?:\n## |\z)/s', $readme_content, $matches ) ? $matches[1] : '',
+				OpenAIEmbeddings::ID => preg_match( '/## Set Up via OpenAI Embeddings(.*?)(?:\n## |\z)/s', $readme_content, $matches ) ? $matches[1] : '',
+				AzureEmbeddings::ID  => '',
+				OllamaEmbeddings::ID => $this->get_locally_hosted_llm_instruction(),
+			],
+		];
 	}
 
 	/**

includes/Classifai/Features/ContentGeneration.php

@@ -27,6 +27,13 @@ class ContentGeneration extends Feature {
 	 */
 	const ID = 'feature_content_generation';
 
+	/**
+	 * Instruction file name for the feature.
+	 *
+	 * @var string
+	 */
+	public $instruction_file = '04.content-generation.md';
+
 	/**
 	 * Prompt for creating content.
 	 *
@@ -95,6 +102,18 @@ public function __construct() {
 			OpenAI::ID  => __( 'Azure OpenAI', 'classifai' ),
 			Ollama::ID  => __( 'Ollama', 'classifai' ),
 		];
+
+		// Get readme content.
+		$readme_content = $this->get_instruction_content();
+
+		// Contains supported providers data.
+		$this->supported_providers_data = [
+			'instruction' => [
+				ChatGPT::ID => preg_match( '/## Set Up via OpenAI ChatGPT(.*?)(?:\n## |\z)/s', $readme_content, $matches ) ? $matches[1] : '',
+				OpenAI::ID  => preg_match( '/## Set Up via Azure OpenAI(.*?)(?:\n## |\z)/s', $readme_content, $matches ) ? $matches[1] : '',
+				Ollama::ID  => $this->get_locally_hosted_llm_instruction(),
+			],
+		];
 	}
 
 	/**

includes/Classifai/Features/ContentResizing.php

@@ -41,6 +41,13 @@ class ContentResizing extends Feature {
 	 */
 	public $expand_prompt = 'Increase the content length no more than 2 to 4 sentences.';
 
+	/**
+	 * Instruction file name for the feature.
+	 *
+	 * @var string
+	 */
+	public $instruction_file = '05.content-resizing.md';
+
 	/**
 	 * Constructor.
 	 */
@@ -59,6 +66,21 @@ public function __construct() {
 			ChromeAI::ID  => __( 'Chrome AI (experimental)', 'classifai' ),
 			Ollama::ID    => __( 'Ollama', 'classifai' ),
 		];
+
+		// Get readme content.
+		$readme_content = $this->get_instruction_content();
+
+		// Contains supported providers data.
+		$this->supported_providers_data = [
+			'instruction' => [
+				ChatGPT::ID   => preg_match( '/## Set Up via OpenAI ChatGPT(.*?)(?:\n## |\z)/s', $readme_content, $matches ) ? $matches[1] : '',
+				GeminiAPI::ID => preg_match( '/## Set Up via Google AI \(Gemini API\)(.*?)(?:\n## |\z)/s', $readme_content, $matches ) ? $matches[1] : '',
+				OpenAI::ID    => preg_match( '/## Set Up via Azure OpenAI(.*?)(?:\n## |\z)/s', $readme_content, $matches ) ? $matches[1] : '',
+				Grok::ID      => '',
+				ChromeAI::ID  => '',
+				Ollama::ID    => $this->get_locally_hosted_llm_instruction(),
+			],
+		];
 	}
 
 	/**

includes/Classifai/Features/DescriptiveTextGenerator.php

@@ -31,6 +31,13 @@ class DescriptiveTextGenerator extends Feature {
 	 */
 	public $prompt = 'You are an assistant that generates descriptions of images that are used on a website. You will be provided with an image and will describe the main item you see in the image, giving details but staying concise. There is no need to say "the image contains" or similar, just describe what is actually in the image. This text will be important for screen readers, so make sure it is descriptive and accurate but not overly verbose. Before returning the text, re-evaluate your response and ensure you are following the above points, in particular ensuring the text is concise.';
 
+	/**
+	 * Instruction file name for the feature.
+	 *
+	 * @var string
+	 */
+	public $instruction_file = '12.descriptive-text-generator.md';
+
 	/**
 	 * Constructor.
 	 */
@@ -47,6 +54,19 @@ public function __construct() {
 			Grok::ID           => __( 'xAI Grok', 'classifai' ),
 			OllamaMM::ID       => __( 'Ollama', 'classifai' ),
 		];
+
+		// Get readme content.
+		$readme_content = $this->get_instruction_content();
+
+		// Contains supported providers data.
+		$this->supported_providers_data = [
+			'instruction' => [
+				ComputerVision::ID => preg_match( '/## Set Up via Microsoft Azure(.*?)(?:\n## |\z)/s', $readme_content, $matches ) ? $matches[1] : '',
+				ChatGPT::ID        => '',
+				Grok::ID           => '',
+				OllamaMM::ID       => $this->get_locally_hosted_llm_instruction(),
+			],
+		];
 	}
 
 	/**

includes/Classifai/Features/ExcerptGeneration.php

@@ -41,6 +41,13 @@ class ExcerptGeneration extends Feature {
 	 */
 	public $woo_prompt = 'Create a concise, compelling summary for an ecommerce product that highlights key features, benefits, and unique selling points. Keep it within {{WORDS}} words and ensure it pairs well with the product title: {{TITLE}}.';
 
+	/**
+	 * Instruction file name for the feature.
+	 *
+	 * @var string
+	 */
+	public $instruction_file = '03.excerpt-generation.md';
+
 	/**
 	 * Constructor.
 	 */
@@ -59,6 +66,21 @@ public function __construct() {
 			ChromeAI::ID  => __( 'Chrome AI (experimental)', 'classifai' ),
 			Ollama::ID    => __( 'Ollama', 'classifai' ),
 		];
+
+		// Get readme content.
+		$readme_content = $this->get_instruction_content();
+
+		// Contains supported providers data.
+		$this->supported_providers_data = [
+			'instruction' => [
+				ChatGPT::ID   => preg_match( '/## Set Up via OpenAI ChatGPT(.*?)(?:\n## |\z)/s', $readme_content, $matches ) ? $matches[1] : '',
+				GeminiAPI::ID => preg_match( '/## Set Up via Google AI \(Gemini API\)(.*?)(?:\n## |\z)/s', $readme_content, $matches ) ? $matches[1] : '',
+				OpenAI::ID    => preg_match( '/## Set Up via Azure OpenAI(.*?)(?:\n## |\z)/s', $readme_content, $matches ) ? $matches[1] : '',
+				Grok::ID      => '',
+				ChromeAI::ID  => '',
+				Ollama::ID    => $this->get_locally_hosted_llm_instruction(),
+			],
+		];
 	}
 
 	/**

includes/Classifai/Features/Feature.php

@@ -7,6 +7,7 @@
 use function Classifai\find_provider_class;
 use function Classifai\should_use_legacy_settings_panel;
 use function Classifai\get_asset_info;
+use function Classifai\safe_wp_remote_get;
 
 abstract class Feature {
 	/**
@@ -28,6 +29,20 @@ abstract class Feature {
 	 */
 	const PLUGIN_AREA_SCRIPT = 'classifai-plugin-fill-js';
 
+	/**
+	 * Plugin feature instruction directory URL.
+	 *
+	 * @var string
+	 */
+	const PLUGIN_FEATURE_INSTRUCTION_DIR = 'https://raw.githubusercontent.com/10up/classifai/refs/heads/develop/wp-hooks-docs/docs/02.feature-configuration';
+
+	/**
+	 * Locally hosted instruction file.
+	 *
+	 * @var string
+	 */
+	const PLUGIN_LOCALLY_HOSTED_INSTRUCTION_URL = 'https://raw.githubusercontent.com/10up/classifai/refs/heads/develop/wp-hooks-docs/docs/03.advanced-docs/06.run-locally-hosted-llms.md';
+
 	/**
 	 * Feature label.
 	 *
@@ -58,6 +73,20 @@ abstract class Feature {
 	 */
 	public $supported_providers = [];
 
+	/**
+	 * Array of providers data supported by the feature.
+	 *
+	 * @var \Classifai\Providers\Provider[]
+	 */
+	public $supported_providers_data = [];
+
+	/**
+	 * Instruction file name for the feature.
+	 *
+	 * @var string
+	 */
+	public $instruction_file = '';
+
 	/**
 	 * Set up necessary hooks.
 	 */
@@ -1411,4 +1440,86 @@ public function run( ...$args ) {
 			$this
 		);
 	}
+
+	/**
+	 * Get Feature Instructions from related file.
+	 *
+	 * @return string
+	 */
+	public function get_instruction_content() {
+		$instruction_file = $this->instruction_file ?? '';
+		$provider         = static::ID;
+
+		if ( empty( $instruction_file ) || empty( $provider ) ) {
+			return;
+		}
+
+		$transient_key = 'classifai_instruction_' . $provider;
+
+		// Get content from cache.
+		$feature_instruction = get_transient( $transient_key );
+
+		if ( ! empty( $feature_instruction ) ) {
+			return $feature_instruction;
+		}
+
+		$instruction_content_url = trailingslashit( self::PLUGIN_FEATURE_INSTRUCTION_DIR ) . $instruction_file;
+
+		// Get content.
+		$instruction_request = safe_wp_remote_get( $instruction_content_url );
+
+		if ( is_wp_error( $instruction_request ) ) {
+			return esc_html__( 'Instruction content cannot be downloaded.', 'classifai' );
+		}
+
+		$feature_instruction = wp_remote_retrieve_body( $instruction_request );
+
+		if ( empty( $feature_instruction ) || ! is_string( $feature_instruction ) ) {
+			return esc_html__( 'Instruction content cannot be downloaded.', 'classifai' );
+		}
+
+		$feature_instruction = wp_kses_post( $feature_instruction );
+
+		// Cache content.
+		set_transient( $transient_key, $feature_instruction, DAY_IN_SECONDS );
+
+		return $feature_instruction;
+	}
+
+	/**
+	 * Get Feature Instructions for locally hosted LLMs.
+	 *
+	 * @return string
+	 */
+	public function get_locally_hosted_llm_instruction() {
+
+		$transient_key = 'classifai_instruction_locally_hosted_llm';
+
+		// Get content from cache.
+		$locally_hosted_instruction = get_transient( $transient_key );
+
+		if ( ! empty( $locally_hosted_instruction ) ) {
+			return $locally_hosted_instruction;
+		}
+
+		$instruction_content_url = self::PLUGIN_LOCALLY_HOSTED_INSTRUCTION_URL;
+		$instruction_request     = safe_wp_remote_get( $instruction_content_url );
+
+		if ( is_wp_error( $instruction_request ) ) {
+			return esc_html__( 'Instruction content cannot be downloaded.', 'classifai' );
+		}
+
+		$locally_hosted_instruction = wp_remote_retrieve_body( $instruction_request );
+
+		if ( empty( $locally_hosted_instruction ) || ! is_string( $locally_hosted_instruction ) ) {
+			return esc_html__( 'Instruction content cannot be downloaded.', 'classifai' );
+		}
+
+		$locally_hosted_instruction = wp_kses_post( preg_replace( '/^---\s*[\s\S]*?\s*---\s*/', '', $locally_hosted_instruction ) );
+
+		// Cache content.
+		set_transient( $transient_key, $locally_hosted_instruction, DAY_IN_SECONDS );
+
+		return $locally_hosted_instruction;
+	}
 }

includes/Classifai/Features/ImageCropping.php

@@ -21,6 +21,13 @@ class ImageCropping extends Feature {
 	 */
 	const ID = 'feature_image_cropping';
 
+	/**
+	 * Instruction file name for the feature.
+	 *
+	 * @var string
+	 */
+	public $instruction_file = '14.image-cropping.md';
+
 	/**
 	 * WP_Filesystem_Base instance.
 	 *
@@ -43,6 +50,16 @@ public function __construct() {
 		$this->supported_providers = [
 			ComputerVision::ID => __( 'Microsoft Azure AI Vision', 'classifai' ),
 		];
+
+		// Get readme content.
+		$readme_content = $this->get_instruction_content();
+
+		// Contains supported providers data.
+		$this->supported_providers_data = [
+			'instruction' => [
+				ComputerVision::ID => preg_match( '/## Set Up via Microsoft Azure(.*?)(?:\n## |\z)/s', $readme_content, $matches ) ? $matches[1] : '',
+			],
+		];
 	}
 
 	/**