autodoc-assembler

Purpose

Produce the final documentation entry point. Read all generated sections, verify cross-references, write the main README and navigation index.

Iron Laws

#	Law
1	Read ALL docs/*.md before writing — no section may be skipped
2	README.md must be self-contained enough to orient a new developer
3	All cross-links between docs must use relative paths
4	Do NOT repeat content from sections — summarize and link

---

Input Contract

docs_sections: "jobs/<job>/docs/*.md"   # all generated sections
project_map: "jobs/<job>/artifacts/project-map.md"
architecture: "jobs/<job>/artifacts/architecture.md"
JOB_DIR: "<job directory>"
PROJECT_DIR: "<project path>"

Output Contract

status: "DONE" | "DONE_WITH_CONCERNS"
summary: "<2-3 sentences: what's in the final package, any gaps>"
concerns: ["<missing info, broken cross-refs, TODO items left by writers>"]
artifact_path: "jobs/<job>/docs/README.md"

---

Workflow

Step 1: Inventory All Sections

Read each docs/*.md file. Note:

• What sections were successfully written
• Any [TODO: ...] markers left by writers (collect into concerns)
• Missing sections that were expected but not generated

Step 2: Write docs/README.md

# <Project Name>

> <one-line description from project-map>

## Overview
<2-3 paragraphs: what the project is, who it's for, main capabilities>

## Architecture
<3-5 bullet summary of architectural style and key components>
→ Full details: [Architecture](architecture.md)

## Quick Start
<condensed 4-step setup: clone → install → configure → run>
→ Full guide: [Onboarding](onboarding.md)

## Documentation

| Document | Description |
|----------|-------------|
| [Getting Started](onboarding.md) | Setup, local dev, common tasks |
| [Architecture](architecture.md) | System design, components, data flow |
| [Module Reference](modules.md) | Per-module breakdown |
| [API Reference](api-reference.md) | Endpoint documentation |
| [Data Models](data-models.md) | Schemas and database structure |

## Tech Stack

| Layer | Technology |
|-------|-----------|
<from project-map>

## Generated By
This documentation was generated automatically by [autodoc](https://github.com/MrCipherSmith/goodai-base).
Generated: <date>

Step 3: Write docs/index.md

# Documentation Index

## <Project Name> — Documentation

Generated: <date> | Source: `<project path>`

### Contents

- **[README](README.md)** — Project overview and quick start
- **[Getting Started](onboarding.md)** — Full setup guide
- **[Architecture](architecture.md)** — System design
- **[Module Reference](modules.md)** — Module-by-module breakdown
- **[API Reference](api-reference.md)** — REST/gRPC/GraphQL endpoints
- **[Data Models](data-models.md)** — Database schemas

### Modules Documented
<list of modules from analysis>

### Coverage Notes
<any TODOs or gaps noted during generation>

Step 4: Return Summary

In the response summary, include:

• Total sections generated
• Any TODO items that need human review
• Suggested next steps (e.g., "API reference has 3 endpoints marked TODO: add description")