GH-SUBMITTER
Gatehouse Submitter Experience
1. Documentation Integrity Gate
All canonical documentation shall pass the Viroway Documentation Lint specification (VW-DL) before merge or downstream generation.
The lint-clean corpus is the only permitted source for:
- datasheet generation;
- Figma master generation;
- ticket generation;
- architecture exports;
- implementation-agent input;
- developer handoff.
Generated artifacts derived from a non-conformant corpus are non-authoritative.
2. Gate downstream generators
Each downstream workflow must depend on docs-lint.
For a combined workflow:
datasheets:
needs: docs-lint
figma-masters:
needs: docs-lint
ticket-generation:
needs: docs-lint
architecture-exports:
needs: docs-lint
developer-handoff:
needs: docs-lint
If these are separate workflows, use a reusable lint workflow or require the Documentation Integrity check in the main branch protection rules.
The key rule is:
No lint-clean corpus → no generated downstream artifact
3. Submitters
Submitters shall receive:
- qualitative score bands;
- dimension-level weaknesses;
- evidence-oriented improvement guidance;
- applicable review status.
Submitters shall not receive, by default:
- exact tenant cut-points;
- modifier values;
- Weight Bundle internals;
- formulas sufficient to target a decision boundary.
Visibility is governed by TG-SG and tenant policy.
4. What downstream workflows currently need docs-lint?
Any process that transforms canonical documentation into another artifact:
| Downstream process | Gate now? |
|---|---|
| Docusaurus documentation build | Yes |
| MkDocs or documentation archive build | Yes |
| Search/index/MCP corpus generation | Yes |
| Datasheet generation | When implemented or if already present |
| Figma master generation | When implemented |
| Jira/ticket generation from docs | When implemented |
| Architecture exports | When implemented |
| AI/developer handoff packages | When implemented |
The repository describes /content as the single documentation source and has Docusaurus/MkDocs-related documentation infrastructure. It also contains documentation guidelines and internal tooling documentation. Therefore the first practical gates should be:
docs-lint
↓
Docusaurus build
MkDocs/archive build
search/index generation
MCP corpus generation
Do not create empty fake workflows for Figma or ticket generation.
Use this rule:
Any future generator that consumes the canonical corpus must declare the docs-lint check as a prerequisite.
The minimal CI dependency is:
build-docs:
needs: docs-lint
and similarly for existing indexing jobs.
5. Documentation Integrity Gate
All canonical documentation shall satisfy the Viroway Docs Lint specification (VW-DL) before merge, publication, indexing, or downstream generation.
The lint-clean corpus is the only permitted source for:
- Docusaurus and MkDocs publication;
- semantic indexing and MCP ingestion;
- datasheet generation;
- Figma master generation;
- ticket generation;
- architecture exports;
- implementation-agent input;
- developer handoff.
Generated artifacts derived from a non-conformant corpus are non-authoritative.
Every engine specification shall declare:
- canonical identity;
- canonical input and output contracts;
- replay-profile coverage;
- governed dependencies;
- pipeline position where applicable.
Branch protection shall require the Documentation Integrity check before merge into the canonical branch.