Documentation

Source content for the Wippy documentation, served at wippy.ai/en/

This repository holds the documentation source for the Wippy platform. It is not a standalone site — the content is consumed by the documentation engine in wippy/puiblic-website-and-documentation, which syncs this repository on every push to main and renders it at https://wippy.ai/<lang>/.

A commit landing on main triggers a re-sync and the change appears at wippy.ai/en/ (and every other supported locale).

Layout

languages.json          # locale code -> content directory (e.g. "en" -> "en")
en/manifest.json        # navigation tree for English
en/start/about.md       # markdown page (frontmatter: title, description)
en/.../*.md
de/ es/ ja/ ko/ pt/ ru/ zh/   # one directory per supported locale

Each locale directory contains a manifest.json (the navigation tree, with title / path / children) and the markdown pages it references. Pages may use YAML frontmatter (title, description, keywords); mermaid code fences and admonitions are supported by the engine.

Frontend documentation validation

After changing en/frontend, run:

node scripts/check-frontend-docs.mjs

The dependency-free check rejects known misleading examples such as stale Wippy frontend package versions, raw product controls, direct parent-window routing, unsafe shadow-root rewrites, and invalid theme guidance.

Attention Context documentation validation

After changing the Attention pages in en/frontend or en/framework, run:

node scripts/check-attention-context-docs.mjs

The check validates the structured attachment example: envelope fields, UTF-8 byte length, SHA-256 digest and canonical JSON. It also rejects live authority fields in durable example content. API behavior and prose are reviewed against the published modules; this check does not qualify a running deployment.

Link validation

After changing Markdown links, run:

node scripts/check-markdown-links.mjs

The checker follows the production documentation engine's URL rules: explicit ./ and ../ links are page-relative, while established bare paths may resolve from the locale root. It rejects unresolved local Markdown targets, manifest paths without pages, and duplicate page paths in a locale's navigation tree.

The Documentation checks workflow in .github/workflows/docs-checks.yml runs all three checks on every pull request and on every push to main.

Contributing

We welcome contributions to improve our documentation! Please read the Contributing Guide to get started.