{% 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 %}