Investec Platform Plugins

Appearance

Plugin documentation knowledge source ​

This repository is the authoritative documentation source for the Investec Platform Plugin packages. The Experience Knowledge Graph can use the canonical pages in this repository to route plugin questions and retrieve the relevant guidance.

The generated graph stores routing metadata and source coordinates. It doesn't store the Markdown body as the authoritative content.

Canonical page contract ​

The graph can ingest a page when its frontmatter contains:

  • A unique title.
  • A retrieval-specific description.
  • At least one supported audience.
  • status: canonical.
  • At least one routing tag in tags.
  • At least one valid repository path in source_of_truth.
  • A last_verified date.

Add task when the page describes a procedure. Keep conceptual and reference pages task-free unless a reader can complete a specific outcome.

Agent manifest ​

Run the manifest generator after changing a canonical page:

sh
npm run docs:manifest

The generator writes docs/public/agent-manifest.json. Each manifest entry contains the page path, title, description, audience, tags, source paths, verification date, and SHA-256 content hash.

The graph compiler uses the hash to detect documentation drift. If a canonical page changes without a regenerated manifest, graph compilation fails with a stale-manifest error.

Validate the knowledge source ​

Run the complete documentation check:

sh
npm run docs:check

The check verifies:

  • The committed manifest matches every canonical page.
  • Required frontmatter fields are present.
  • Audiences use the supported values.
  • source_of_truth paths resolve inside this repository.
  • Local Markdown links resolve.
  • VitePress builds the published documentation site.

Update a plugin page ​

  1. Verify the claim against the plugin's source_of_truth files.
  2. Update the page's purpose, public contract, extension location, or approval boundary.
  3. Update last_verified to the verification date.
  4. Run npm run docs:manifest.
  5. Run npm run docs:check.
  6. Commit the page and generated manifest together.

Don't put credentials, customer data, production responses, or documentation bodies into graph declarations. Keep implementation detail in the plugin source and supported guidance in the canonical page.

Repository ownership ​

cxt-channel-investec-plugins owns plugin implementation and plugin documentation. experience-platform-runtime owns graph compilation, routing, evaluation, packaging, and release artefacts.

Publishing a plugin package or changing its documentation doesn't update the platform or graph automatically. Each repository must review and adopt its corresponding change.