Vetrix system documentation

System, architecture, and internal-design reference for the Vetrix platform. Pages are organized by type.

Install

Deployment and host setup.

• install/README.md — choosing a runtime and fronting it: Docker, Kubernetes, and the nginx reverse proxy

Configuration

Configuration is documented with the surface it applies to.

• install/docker.md — environment variables read at startup
• ../admin-docs/ui/configuration.md — runtime instance settings and the admin settings API

Architecture

How the platform is built — naming doctrine, CI/CD, search, frontend, and security internals.

• architecture/README.md — the platform-wide implementation contracts and the CI/CD, frontend, search, and security subsystem references

Testing

Test surfaces, fixtures, and the contributor testing rules.

• testing/README.md — which suites exist, how to run them locally, and the rules a change must satisfy before it merges

Accessibility

• accessibility/README.md — the manual verification script for a release and the CI gate that holds it in place

Tooling

Code-scanning tooling and the .vetrix/tooling.yml configuration.

• tooling/README.md — which scanner fires on which language, the .vetrix/tooling.yml schema, finding exports, the pre-commit scaffolder, and the per-scanner reference

Contributing — operator-manual guardrail

These pages are an operator manual. Before opening a pull request, run the manual doc-lint. The command below works from any directory inside a clone:

bash "$(git rev-parse --show-toplevel)/llm-documentation/system-docs/doc-lint.sh"

The script switches to the repository root itself and scans every tracked Markdown and YAML file, so a single run covers all five documentation sets. Each set holds an identical copy of the script; running any one of them lints the whole tree, so this is not a per-set lint.

The script fails — listing file:line — when an operator-manual rule is violated. The Docs Reviewer enforces the same rules:

• Use gitvetrix.com as the only product host (the .test dev host is fine).
• Refer to the platform as Vetrix; do not use the legacy product name.
• Keep tracker IDs out of the prose.
• Link to other pages with relative .md paths. A markdown link whose target is an absolute git-host URL (https://www.gitvetrix.com/... or https://gitvetrix.com/...) fails the lint, because it sends the reader out of the manual and into the repository file browser; this is checked case-insensitively across inline links, reference-style link definitions, bare autolinks (a URL wrapped only in < >, no square brackets), and angle-bracket-wrapped destinations, including a userinfo-prefixed form (e.g. https://user:token@ in front of the host). Bare-text host mentions, curl examples and code blocks are unaffected.
• Write in present-tense operator-manual tone, without decision or history narration.

doc-lint.sh must pass before review.