website-htmx-rustelo-code/site/templates/build-tools/documentation/top_level.tera

{% extends "documentation/base.tera" %}

{% block title %}{{ i18n.labels.title_top_level }}{% endblock title %}

{% block toc %}
## {{ i18n.labels.table_of_contents }}

- [{{ i18n.labels.overview }}](#overview)
- [🔧 Server Routes](#server-routes)
- [📄 Page Routes](#page-routes)
- [🧩 Components](#components)
- [🤖 Automation](#automation)
- [📊 Statistics](#statistics)

{% endblock toc %}

{% block content %}

## {{ i18n.labels.overview }} {% raw %}{#overview}{% endraw %}

This is a comprehensive documentation system for the **{{ metadata.project_name }}** web application. The documentation is automatically generated from code analysis and provides detailed information about routes, components, and pages.

### Quick Navigation

| Section | {{ i18n.labels.summary }} | Reference | Description |
|---------|---------|-----------|-------------|
| **🔧 Server** | [server/summary.md](server/summary.md) | [server/reference.md](server/reference.md) | API routes, handlers, and middleware |
| **📄 Pages** | [pages/summary.md](pages/summary.md) | [pages/reference.md](pages/reference.md) | Page routes and components |
| **🧩 Components** | [components/summary.md](components/summary.md) | [components/reference.md](components/reference.md) | Reusable UI components |

---

## 🔧 Server Routes {% raw %}{#server-routes}{% endraw %}

**{{ summary.total_routes }}** total routes | **{{ summary.api_routes }}** API routes | **{{ summary.static_routes }}** static routes

### Route Categories

{# Routes grouped by auth requirement #}

- **🔒 Authentication Required**: {{ auth_routes | length }} routes
- **🌐 Public Access**: {{ public_routes | length }} routes
- **📁 Static Files**: {{ summary.static_routes }} routes

### Popular Routes

{% for route in doc.routes %}
- [`{{ route.path }}`](server/reference.md#{{ route.anchor }}) - {{ route.response_type }}
{% endfor %}

[**View all server routes →**](server/reference.md)

---

## 📄 Page Routes {% raw %}{#page-routes}{% endraw %}

**{{ summary.total_pages }}** pages across **{{ summary.languages | length }}** languages

### By Language

**Multiple languages supported**

### Recent Pages

{% for page in doc.pages %}
- [`{{ page.path }}`](pages/reference.md#{{ page.anchor }}) ({{ page.language | upper }}) - {{ page.component }}
{% endfor %}

[**View all page routes →**](pages/reference.md)

---

## 🧩 Components {% raw %}{#components}{% endraw %}

**{{ summary.total_components }}** reusable components

### Component Types

**Various component types available**

### Key Components

{% for component in doc.components %}
- [`{{ component.name }}`](components/reference.md#{{ component.anchor }}) - {{ component.component_type }}
{% endfor %}

[**View all components →**](components/reference.md)

---

## 🤖 Automation {% raw %}{#automation}{% endraw %}

This documentation system powers several automation features:

### Available Integrations

- **🎛️ Rustelo Manager** - Live route management and editing
- **🔌 MCP Server** - AI assistant integration via Model Context Protocol
- **📝 API Clients** - Auto-generated TypeScript/Rust clients
- **🧪 Test Generation** - Automated integration tests
- **📋 OpenAPI Specs** - Swagger/Postman collections

### Quick Actions

```bash
# Generate API client
cargo run --bin api-client-generator --lang typescript

# Export to OpenAPI
cargo run --bin openapi-exporter --output api-spec.yaml

# Validate documentation
cargo run --bin docs-validator
```

[**View automation guide →**](automation/reference.md)

---

## 📊 Statistics {% raw %}{#statistics}{% endraw %}

### System Overview

| Metric | Value | Notes |
|--------|-------|-------|
| **{{ i18n.labels.total_routes }}** | {{ summary.total_routes }} | Including API and static routes |
| **{{ i18n.labels.total_components }}** | {{ summary.total_components }} | Reusable UI components |
| **{{ i18n.labels.total_pages }}** | {{ summary.total_pages }} | Across all languages |
| **{{ i18n.labels.languages }}** | {{ summary.languages | join(sep=", ") }} | Supported languages |
| **{{ i18n.labels.auth_required }}** | {{ summary.auth_required_routes }} | Routes requiring authentication |

### Documentation Coverage

- ✅ **Route Documentation**: {{ (summary.total_routes / summary.total_routes * 100) | round }}%
- ✅ **Component Documentation**: {{ (summary.total_components / summary.total_components * 100) | round }}%
- ✅ **Page Documentation**: {{ (summary.total_pages / summary.total_pages * 100) | round }}%

---

*Last updated: {{ metadata.generated_at }}*

**Need help?** Check the [automation guide](automation/reference.md) for integration examples and advanced usage.

{% endblock content %}