# Documentation Platform - Overview

This repository contains two distinct LikeC4 architecture documentation projects:

## 📁 Structure

### `resources/edp-likec4/`

**Enterprise Developer Platform (EDP) Architecture**

Contains architecture models for the platform itself - the systems, services, and infrastructure that make up the EDP.

**Purpose:** Document what we build

### `resources/doc-likec4/`

**Documentation Platform Architecture**

Contains architecture models that explain how this documentation system works - the Hugo/Docsy setup, CI/CD pipeline, and deployment process.

**Purpose:** Document how we document (meta-documentation)

## 🎯 For New Documentors

If you're new to the documentor role and want to understand the documentation platform:

1. **Read the documentation about documentation:**
   → `content/en/docs/documentation/`

2. **View the architecture diagrams:**
   → The documentation pages embed interactive LikeC4 diagrams

3. **Key sections:**
   - [Overview](content/en/docs/documentation/_index.md) - What is a documentor?
   - [Local Development](content/en/docs/documentation/local-development.md) - Get started
   - [Testing](content/en/docs/documentation/testing.md) - Quality assurance
   - [CI/CD](content/en/docs/documentation/cicd.md) - Automated pipeline
   - [Publishing](content/en/docs/documentation/publishing.md) - Deployment to edge

## 🚀 Quick Start

```bash
# Start development server
task serve

# Run tests
task test:quick

# View architecture models
cd resources/doc-likec4
npm install
npm start
```

## 📊 Architecture Views

The documentation platform is visualized with these views:

- **Overview** - Complete system overview
- **Local Development** - Documentor workflow
- **CI/CD Pipeline** - Automated testing
- **Deployment Flow** - Edge deployment process
- **Full Workflow** - End-to-end journey
- **Testing Capabilities** - Quality assurance

## 🔗 Related Files

- `Taskfile.yml` - Automation for local development and CI
- `.github/workflows/test.yml` - GitHub Actions CI pipeline
- `k8s-deployment.yaml` - Kubernetes deployment manifest
- `edgeconnectdeployment.yaml` - Edge Connect configuration
- `Dockerfile` - Container image definition

## 📚 Documentation

The documentation is built with:

- **Hugo** - Static site generator
- **Docsy** - Documentation theme
- **LikeC4** - Architecture visualization
- **Task** - Build automation
- **GitHub Actions** - CI/CD
- **Edge Connect** - Deployment platform

## 🎓 Learn More

For complete information, browse to the documentation section after starting the server:

```bash
task serve
# Then open: http://localhost:1313/docs/documentation/
```
