Xophz Yellow Links

Category: Command Deck · Version: 26.7.21 · Text Domain: xophz-compass-yellow-links

Standalone WordPress backend and router for the Yellow Links web application within the COMPASS ecosystem.

Overview

Xophz Yellow Links provides the server-side architecture, custom content models, Gemini AI intelligence endpoints, and federated networking for the Yellow Links web app. It acts as both a standalone WordPress plugin and a custom single-page application (SPA) router.

Core Capabilities

• Custom Post Type & Meta Schema – Registers yellow_link custom post type, yellow_link_category taxonomy, and structured metadata for link indexing and safety scoring.
• Gemini AI Integration – REST API endpoints powered by Gemini 3.5 Flash for automated link categorization, tag extraction, description summaries, ad generation, and security/safety assessment.
• Sister Sites Federation – Distributed directory networking that allows multiple Yellow Links installations to exchange and aggregate link indices with local transient caching.
• Dynamic Frontend SPA Router – Intercepts custom slug requests (e.g. /yellow-links) to serve the compiled Vue/Vite frontend bundle or proxy to a local Vite development server.
• Admin Management Panel – WP-Admin options page (Settings > Yellow Links) to configure deployment slugs and sister site federation URLs.

Requirements

• WordPress: 5.8+
• PHP: 7.4+ (PHP 8.0+ recommended)
• Environment: GEMINI_API_KEY environment variable configured for AI link analysis features.

REST API Reference

All endpoints are registered under the yellow-links/v1 REST namespace:

AI Analysis Response Schema

{
  "description": "Clean 1-2 sentence summary of the website.",
  "category": "Tech & Dev",
  "tags": ["OPEN-SOURCE", "TOOLING", "CLI"],
  "safetyStatus": "safe",
  "safetyReason": "Verified as a safe public developer utility."
}

Data Architecture & PHP Class Map

Post Meta Fields (yellow_link)

• yl_url: Target URL for the directory entry.
• yl_tags: JSON string array of tags associated with the link.
• yl_safetyStatus: Safety assessment status (safe, warning, or unsafe).
• yl_safetyReason: Objective explanation for the safety rating.
• yl_rating: Aggregate user rating score.

Installation & Setup

1. Upload xophz-compass-yellow-links to /wp-content/plugins/.
2. Activate the plugin through the Plugins menu in WordPress.
3. Configure settings under Settings > Yellow Links:
   • Deployment Slug: Set custom endpoint URL (defaults to yellow-links).
   • Sister Sites (Federation): Enter sister site URLs (one per line) to aggregate network links.
4. Ensure GEMINI_API_KEY is set in your environment if using AI link analysis features.

Frontend Integration

The plugin looks for built frontend assets at public/dist/index.html or within apps/yellow-links/dist/index.html. During development (WP_DEBUG or WP_ENV=development), it automatically proxies requests to the local Vite dev server on port 8088.