website-and-documentation/resources/doc-likec4/README.md

# Documentation Platform Architecture

This folder contains LikeC4 architecture models that document the documentation platform itself.

## Purpose

These models help new **Technical Writers** understand:

- How the documentation platform works
- The local development workflow
- CI/CD pipeline and testing processes
- Deployment to edge infrastructure

## Models

- `documentation-platform.c4` - Main model with all elements and relationships
- `views.c4` - View definitions for different perspectives

## Views

### Overview

High-level view of the entire documentation platform, showing all major components.

### Local Development Workflow

How a technicalWriter works locally with content, Taskfile, and Hugo server.

### CI/CD Pipeline

Automated testing and container build process via GitHub Actions.

### Deployment Flow

How documentation is deployed to the edge environment via Kubernetes.

### Full Workflow

End-to-end process from content creation to published documentation.

### Testing Capabilities

All automated tests that ensure documentation quality.

## Usage

### Start LikeC4 Development Server

```bash
cd resources/doc-likec4
npm install
npm start
```

This opens the LikeC4 IDE in your browser where you can:

- Edit models interactively
- Preview views in real-time
- Export diagrams

### Embed in Documentation

In your Markdown files:

```markdown
{{< likec4-view view="overview" project="documentation-platform" >}}
```

Optional parameters:
- `view` (required) - The view ID from your LikeC4 model
- `project` (optional, default: "architecture") - The LikeC4 project name
- `title` (optional, default: "Architecture View: {view}") - Custom header text

Example with custom title:

```markdown
{{< likec4-view view="overview" project="documentation-platform" title="Complete Documentation Platform" >}}
```

## Configuration

- `likec4.config.json` - Project configuration
- `package.json` - LikeC4 CLI dependencies

## Related Documentation

The models are documented in: `content/en/docs/documentation/`

- Overview and introduction
- Local development guide
- Testing processes
- CI/CD pipeline
- Publishing to edge