Skip to content

Native Content Relationships — Documentation

This folder is the source for the VitePress documentation site.

Develop locally

From the plugin root (one level up):

bash
npm install
npm run docs:dev

Open the URL VitePress prints (e.g. with base path /WP-Native-Content-Relationships/ for GitHub Pages).

Build for production

bash
npm run docs:build

Output is in docs/.vitepress/dist. Deploy that folder to GitHub Pages or any static host.

Structure

PathPurpose
index.mdHome page
guide/getting-started.mdFirst steps
technical/architecture.mdSystem design, components
technical/performance.mdBenchmarks, scaling
product/features.mdFeature overview
internal/expansion-plan.md90-day plan (internal)
.vitepress/config.mtsVitePress config
public/Static assets (logo, etc.)

Original long-form docs (e.g. ARCHITECTURE.md, PERFORMANCE.md, MUST_HAVE_FEATURES.md, 90-DAY-EXPANSION-PLAN.md) remain in this folder as canonical sources; the VitePress pages either mirror them or summarize and link.

Legacy

The old Jekyll site (_config.yml, *.html pages) is no longer used. The live site is built with VitePress. The HTML files are kept for reference only.

Schema stable from 1.x onward. Backward compatibility guaranteed.