AI-DLC Publication Guide

Overview

This document explains how the AI-DLC materials for this project are made visible to readers.

The goal is not just to ship the application itself, but to preserve the method by which it was created.

Why Publication Matters in AI-DLC

AI-DLC is valuable because it leaves behind a readable trail of intent, planning, design, and execution.

If those artifacts remain hidden inside a private working directory, future readers lose much of the benefit.

This project treats the generated documentation as part of the product story.

What Is Made Visible

This repository exposes AI-DLC information in several layers:

• Root README

  • High-level entry point for repository readers

• aidlc-docs/

  • The project-specific AI-DLC artifact set created during the work

• aidlc-rules/

  • The reusable rule pack that explains the methodology behind the generated artifacts

• /ai-dlc/

  • A reader-friendly public explanation of the AI-DLC approach in this app

• /aidlc-docs/

  • A public copy of the generated project documents for direct browsing

Publication Model

The publication model for this app is simple:

1. maintain the source AI-DLC artifacts in aidlc-docs/
2. generate a public copy of those documents for the application
3. provide a human-friendly methodology page that explains how to read them
4. link the public pages from the app itself

This makes the documentation discoverable without requiring access to the original AI chat session.

Reader Journey

The intended reading flow is:

1. open /ai-dlc/ to understand the methodology at a high level
2. open /aidlc-docs/ to browse the generated project artifacts
3. start with README.md, how-aidlc-works.md, aidlc-state.md, and the requirements/design documents
4. move into plans and audit history for deeper traceability

Commands Used for Publication

Update public AI-DLC documents

npm run docs:public

Build the app with public AI-DLC documents included

npm run build

Run locally with public AI-DLC documents available

npm run dev

Source of Truth Guidance

Use these sources in this order when interpreting the project:

1. application behavior
2. source code under the workspace root
3. project AI-DLC artifacts in aidlc-docs/
4. reusable methodology references in aidlc-rules/

Notes Specific to This Project

• The public AI-DLC pages are intended for users, reviewers, and future collaborators
• The generated documents show how the app was created with the AI-DLC approach
• Some design artifacts describe planning intent, while the source tree reflects the current implementation
• Making aidlc-docs public is part of the transparency goal of this repository