Skip to content

Documentation Consolidation

Status: In Progress Repository: technical-documentation Project directory: workspace/projects/ad-hoc/documentation/consolidate-documentation/

Consolidate all existing Arda documentation into a unified site structure with consistent frontmatter, terminology, and cross-references. Migrate from the existing MkDocs-based layout to the new Starlight (Astro) documentation site framework.

The site is structured around eight areas:

AreaDescription
ProductPoint-in-time description of Arda’s offerings, features, use cases, and end-user publications
DomainKnowledge about material flow, operations science, and the Arda information model
Current SystemTechnical documentation of the running system: architecture, data model, runtime, artifacts
VisionLong-term view of the product and system when the roadmap completes
RoadmapProjects and initiatives organized by status: Completed, In Progress, Backlog, Ideas
ProcessArda Product Development System and craft best practices
TechnologyTechnology guides, recommendations, and standards
AboutDocumentation site structure, authoring workflows, and contributor conventions

The staging area at workspace/projects/ad-hoc/documentation/consolidate-documentation/staging-area/ is the working location for files being prepared. Files are reviewed and moved to the technical-documentation repository once approved.

  • Markets and Value: complete.
  • Features: purchase order feature and UX design overview complete.
  • Cross-cutting patterns: Edit-Draft-Publish and Resource Concept complete.
  • Offerings / Releases: 2026-02-20 release notes complete.
  • Publications: all 17 end-user guides complete.
  • In progress.
  • Templates and authoring guides: in progress.

Every file in the documentation site uses this frontmatter:

---
title: "Document Title"
tags: [area, sub-area, topic, ...]
domain: area
maturity: draft | review | approved | published
author: "Arda Systems"
---