Home

Purpose: The UIAO Contributor Wiki is the operational workbench for building and maintaining the UIAO documentation pipeline. It covers local setup, CI/CD workflows, style standards, diagram conventions, and troubleshooting. Audience: Developers, contributors, and pipeline maintainers. Cross-Links: UIAO Canon (Read the Docs) | Source Repository

UIAO Documentation Wiki

This wiki is the operational guide for contributors to the uiao-docs repository. It covers workflows, setup, CI/CD, and troubleshooting — not architecture, compliance theory, or documentation content. Those live in the rendered site.

Quick Links

Resource	Description
Live Documentation Site	Rendered HTML — auto-deployed from main
uiao-docs repository	Quarto .qmd source files, YAML data schemas, CI/CD workflows
uiao-core repository	OSCAL generation engine, adapter framework, Python code
Repository Ownership & SSOT Policy	Start here — who owns what and where things live

What This Wiki Is (and Is NOT)

This wiki covers:

• How to set up, render, and contribute to the project
• How the CI/CD pipeline works and how to debug it
• Operational standards: style, format, diagram conventions, ADRs
• Troubleshooting common build and render failures

This wiki does not cover:

• Architecture concepts — see the rendered site
• Compliance mappings, Zero Trust theory, or control planes — those are canon documents
• Vendor technology descriptions — see vendor_stack_v1.0.qmd in the rendered site
• Glossary definitions — see 11_GlossaryAndDefinitions.qmd in the rendered site
• Modernization roadmap or timeline — see 08_ModernizationTimeline.qmd in the rendered site

If you are looking for documentation content rather than contributor tooling, go to the rendered site.

Page Index

Policy

• Repository Ownership & SSOT Policy — who owns what, duplication rules, where things live

Getting Started

• Getting Started — local setup, clone, first render
• Rendering Locally — HTML, DOCX, PPTX render workflows
• Adding a New Document — create .qmd files with correct frontmatter
• Contributing Guidelines — branch workflow, commit conventions, PR process
• Repository Structure — directory layout and key files

Working With

• Working with Adapters — adapter subsystem contributor guide
• Diagram Standards — PlantUML and Gemini conventions

Standards

• Style Guide Summary — tone, formatting rules, frozen definitions
• Format Decision Matrix — when to use which output format
• YAML Data Schemas — inventory of all 30 YAML files in data/
• Architecture Decision Records — ADR index and template

Operations

• CI/CD Pipeline — active workflows and build pipeline reference
• Workflow Cleanup Guide — cleanup history and current active workflow rationale
• Governance and Drift Detection — how to run drift checks and repo hygiene
• Troubleshooting — common errors and fixes
• Changelog — documentation milestones