diff --git a/.github/workflows/build-and-deploy.yml b/.github/workflows/build-and-deploy.yml index 24917a2..8d9b046 100644 --- a/.github/workflows/build-and-deploy.yml +++ b/.github/workflows/build-and-deploy.yml @@ -178,44 +178,46 @@ jobs: fi done - - name: Create Jekyll collections + - name: Create Jekyll directory structure run: | - # Create collection files for Jekyll + # Create directory-based structure that matches navigation expectations - # German collections - mkdir -p _architecture _user-guide _howtos _faq + # Create German index pages + mkdir -p architecture user-guide howtos faq if [ -f "docs/de/architecture/arc42-documentation.md" ]; then - cp "docs/de/architecture/arc42-documentation.md" "_architecture/arc42-documentation-de.md" + cp "docs/de/architecture/arc42-documentation.md" "architecture/index.md" fi if [ -f "docs/de/user-guide/user-guide.md" ]; then - cp "docs/de/user-guide/user-guide.md" "_user-guide/user-guide-de.md" + cp "docs/de/user-guide/user-guide.md" "user-guide/index.md" fi if [ -f "docs/de/howtos/import-gps-data.md" ]; then - cp "docs/de/howtos/import-gps-data.md" "_howtos/import-gps-data-de.md" + cp "docs/de/howtos/import-gps-data.md" "howtos/index.md" fi if [ -f "docs/de/faq/general-faq.md" ]; then - cp "docs/de/faq/general-faq.md" "_faq/general-faq-de.md" + cp "docs/de/faq/general-faq.md" "faq/index.md" fi - # English collections + # Create English index pages + mkdir -p en/architecture en/user-guide en/howtos en/faq + if [ -f "docs/en/architecture/arc42-documentation.md" ]; then - cp "docs/en/architecture/arc42-documentation.md" "_architecture/arc42-documentation-en.md" + cp "docs/en/architecture/arc42-documentation.md" "en/architecture/index.md" fi if [ -f "docs/en/user-guide/user-guide.md" ]; then - cp "docs/en/user-guide/user-guide.md" "_user-guide/user-guide-en.md" + cp "docs/en/user-guide/user-guide.md" "en/user-guide/index.md" fi if [ -f "docs/en/howtos/import-gps-data.md" ]; then - cp "docs/en/howtos/import-gps-data.md" "_howtos/import-gps-data-en.md" + cp "docs/en/howtos/import-gps-data.md" "en/howtos/index.md" fi if [ -f "docs/en/faq/general-faq.md" ]; then - cp "docs/en/faq/general-faq.md" "_faq/general-faq-en.md" + cp "docs/en/faq/general-faq.md" "en/faq/index.md" fi - name: Setup Pages @@ -225,10 +227,12 @@ jobs: uses: actions/jekyll-build-pages@v1 with: source: ./ - destination: ./_site + destination: ./dist - name: Upload artifact uses: actions/upload-pages-artifact@v3 + with: + path: ./dist deploy: environment: diff --git a/.gitignore b/.gitignore index 2242f4d..0ea04eb 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,5 @@ # Jekyll and Ruby -_site/ +dist/ .sass-cache/ .jekyll-cache/ .jekyll-metadata @@ -13,6 +13,16 @@ temp.html docs/de/ docs/en/ +# Generated markdown files (should only exist during build) +architecture/index.md +user-guide/index.md +howtos/index.md +faq/index.md +en/architecture/index.md +en/user-guide/index.md +en/howtos/index.md +en/faq/index.md + # Node modules and npm node_modules/ npm-debug.log* diff --git a/_config.yml b/_config.yml index d4b56d0..93c3fe2 100644 --- a/_config.yml +++ b/_config.yml @@ -8,47 +8,13 @@ url: "https://trailmarks-io.github.io" markdown: kramdown highlighter: rouge theme: minima - -# Collections for different document types -collections: - architecture: - output: true - permalink: /:collection/:name/ - user-guide: - output: true - permalink: /:collection/:name/ - howtos: - output: true - permalink: /:collection/:name/ - faq: - output: true - permalink: /:collection/:name/ +destination: dist # Default settings defaults: - scope: path: "" - type: "posts" - values: - layout: "post" - - scope: - path: "" - type: "architecture" - values: - layout: "page" - - scope: - path: "" - type: "user-guide" - values: - layout: "page" - - scope: - path: "" - type: "howtos" - values: - layout: "page" - - scope: - path: "" - type: "faq" + type: "pages" values: layout: "page" diff --git a/architecture/index.md b/architecture/index.md deleted file mode 100644 index f0c177c..0000000 --- a/architecture/index.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -layout: page -title: Architektur -lang: de ---- - -# Architektur-Dokumentation - -Diese Sektion enthält die technische Architektur-Dokumentation für Trailmarks.io nach dem ARC42-Standard. - -## Verfügbare Dokumente - -### 🏗️ [ARC42 Architektur-Dokumentation](arc42-documentation) -Vollständige Architektur-Dokumentation nach dem ARC42-Template mit C4-Modell Visualisierungen. - -**Inhalte:** -- Einführung und Ziele -- Randbedingungen -- Kontextabgrenzung -- Lösungsstrategie -- Bausteinsicht -- Laufzeitsicht -- Verteilungssicht -- Querschnittliche Konzepte -- Architekturentscheidungen -- Risiken und technische Schulden -- Glossar - -## Diagramme und Visualisierungen - -Die Architektur-Dokumentation verwendet das **C4-Modell** für die Visualisierung: - -- **Context Diagrams**: Systemkontext und externe Abhängigkeiten -- **Container Diagrams**: High-Level Systemarchitektur -- **Component Diagrams**: Detaillierte Komponentensicht -- **Deployment Diagrams**: Verteilungsarchitektur - -Alle Diagramme werden mit **PlantUML** erstellt und automatisch generiert. - -## Weitere Ressourcen - -- 📖 [Benutzerhandbuch](/user-guide/) - Anwenderdokumentation -- 🛠️ [How-To Anleitungen](/howtos/) - Entwickler-Anleitungen -- ❓ [FAQ](/faq/) - Technische FAQs - ---- - -*Letzte Aktualisierung: {{ site.time | date: "%d.%m.%Y" }}* \ No newline at end of file diff --git a/en/architecture/index.md b/en/architecture/index.md deleted file mode 100644 index 2e4d150..0000000 --- a/en/architecture/index.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -layout: page -title: Architecture -lang: en ---- - -# Architecture Documentation - -This section contains the technical architecture documentation for Trailmarks.io following the ARC42 standard. - -## Available Documents - -### 🏗️ [ARC42 Architecture Documentation](arc42-documentation) -Complete architecture documentation following the ARC42 template with C4 model visualizations. - -**Contents:** -- Introduction and goals -- Architecture constraints -- Context and scope -- Solution strategy -- Building block view -- Runtime view -- Deployment view -- Cross-cutting concepts -- Architecture decisions -- Risks and technical debt -- Glossary - -## Diagrams and Visualizations - -The architecture documentation uses the **C4 Model** for visualization: - -- **Context Diagrams**: System context and external dependencies -- **Container Diagrams**: High-level system architecture -- **Component Diagrams**: Detailed component view -- **Deployment Diagrams**: Deployment architecture - -All diagrams are created with **PlantUML** and automatically generated. - -## Additional Resources - -- 📖 [User Guide](/en/user-guide/) - User documentation -- 🛠️ [How-To Guides](/en/howtos/) - Developer guides -- ❓ [FAQ](/en/faq/) - Technical FAQs - ---- - -*Last updated: {{ site.time | date: "%m/%d/%Y" }}* \ No newline at end of file diff --git a/en/faq/index.md b/en/faq/index.md deleted file mode 100644 index 758b102..0000000 --- a/en/faq/index.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -layout: page -title: FAQ - Frequently Asked Questions -lang: en ---- - -# Frequently Asked Questions (FAQ) - -Here you'll find answers to the most common questions about Trailmarks.io. - -## Available FAQs - -### ❓ [General FAQ](general-faq) -Comprehensive collection of frequently asked questions and their answers. - -**Categories:** -- **General Questions** - What is Trailmarks.io, costs, supported devices -- **Account and Login** - Registration, password reset, account deletion -- **Trail Management** - Limits, visibility, supported formats -- **GPS and Navigation** - GPS issues, accuracy, offline navigation -- **Technical Issues** - Page won't load, upload problems, troubleshooting -- **Privacy and Security** - Privacy, export options -- **Support** - Contact, bug reports, additional documentation - -## Quick Help - -### 🔧 Most Common Issues - -**GPS not working?** -→ Check your browser permissions and try outdoors. - -**Upload failing?** -→ Make sure the file is under 10 MB and in GPX format. - -**Page won't load?** -→ Clear browser cache and try again. - -## Additional Help - -If you can't find your question here: - -- 📖 [User Guide](/en/user-guide/) - Detailed instructions -- 🛠️ [How-To Guides](/en/howtos/) - Specific tasks -- 💬 **Contact Support**: support@trailmarks.io - ---- - -*Last updated: {{ site.time | date: "%m/%d/%Y" }}* \ No newline at end of file diff --git a/en/howtos/index.md b/en/howtos/index.md deleted file mode 100644 index f2c291e..0000000 --- a/en/howtos/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -layout: page -title: How-To Guides -lang: en ---- - -# How-To Guides - -Here you'll find detailed step-by-step instructions for specific tasks in Trailmarks.io. - -## Available Guides - -### 📁 [Import Trail with GPS Data](import-gps-data) -Step-by-step guide for importing GPX files and other GPS formats. - -**What you'll learn:** -- Prepare GPX files -- Perform the import process -- Configure import settings -- Resolve common issues - -## Planned Guides - -- 📤 **Export Trail Data** - Export to various formats -- 📍 **Manage POI (Points of Interest)** - Add interesting points -- 🗺️ **Use Offline Maps** - Use trails offline -- 👥 **Share Trails with Others** - Sharing and collaboration -- 📊 **Statistics and Reports** - Analyze your activities -- 🔧 **API Integration** - Developer integration - -## Additional Resources - -- 📖 [User Guide](/en/user-guide/) - Complete documentation -- ❓ [FAQ](/en/faq/) - Frequently asked questions -- 🏗️ [Architecture](/en/architecture/) - Technical details - -## Contributing - -Have an idea for a new guide? Create an issue in our [GitHub Repository](https://github.com/trailmarks-io/docs/issues). - ---- - -*Last updated: {{ site.time | date: "%m/%d/%Y" }}* \ No newline at end of file diff --git a/en/user-guide/index.md b/en/user-guide/index.md deleted file mode 100644 index f13e62b..0000000 --- a/en/user-guide/index.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -layout: page -title: User Guide -lang: en ---- - -# User Guide - -Welcome to the Trailmarks.io User Guide! Here you'll find all the information you need to successfully use the application. - -## Available Documents - -### 📖 [Complete User Guide](user-guide) -Comprehensive guide to using Trailmarks.io, from registration to advanced features. - -**Contents:** -- Getting started and account creation -- Dashboard overview -- Trail management -- Navigation and maps -- Advanced features -- Troubleshooting - -## Additional Resources - -- 🛠️ [How-To Guides](/en/howtos/) - Step-by-step instructions -- ❓ [FAQ](/en/faq/) - Frequently asked questions -- 🏗️ [Architecture](/en/architecture/) - Technical documentation - -## Support - -If you need additional help: - -- **Email**: support@trailmarks.io -- **Community Forum**: https://community.trailmarks.io -- **GitHub Issues**: https://github.com/trailmarks-io/docs/issues - ---- - -*Last updated: {{ site.time | date: "%m/%d/%Y" }}* \ No newline at end of file diff --git a/faq/index.md b/faq/index.md deleted file mode 100644 index c7911ca..0000000 --- a/faq/index.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -layout: page -title: FAQ - Häufig gestellte Fragen -lang: de ---- - -# Häufig gestellte Fragen (FAQ) - -Hier finden Sie Antworten auf die häufigsten Fragen zu Trailmarks.io. - -## Verfügbare FAQs - -### ❓ [Allgemeine FAQ](general-faq) -Umfassende Sammlung häufig gestellter Fragen und deren Antworten. - -**Kategorien:** -- **Allgemeine Fragen** - Was ist Trailmarks.io, Kosten, unterstützte Geräte -- **Konto und Anmeldung** - Registrierung, Passwort-Reset, Konto löschen -- **Trail-Management** - Limits, Sichtbarkeit, unterstützte Formate -- **GPS und Navigation** - GPS-Probleme, Genauigkeit, Offline-Navigation -- **Technische Probleme** - Seite lädt nicht, Upload-Probleme, Fehlerbehebung -- **Datenschutz und Sicherheit** - Datenschutz, Export-Möglichkeiten -- **Support** - Kontakt, Bug-Reports, weitere Dokumentation - -## Schnelle Hilfe - -### 🔧 Häufigste Probleme - -**GPS funktioniert nicht?** -→ Überprüfen Sie Ihre Browser-Berechtigungen und versuchen Sie es im Freien. - -**Upload schlägt fehl?** -→ Stellen Sie sicher, dass die Datei unter 10 MB und im GPX-Format ist. - -**Seite lädt nicht?** -→ Leeren Sie den Browser-Cache und versuchen Sie es erneut. - -## Weitere Hilfe - -Falls Sie Ihre Frage hier nicht finden: - -- 📖 [Benutzerhandbuch](/user-guide/) - Detaillierte Anleitungen -- 🛠️ [How-To Anleitungen](/howtos/) - Spezifische Aufgaben -- 💬 **Support kontaktieren**: support@trailmarks.io - ---- - -*Letzte Aktualisierung: {{ site.time | date: "%d.%m.%Y" }}* \ No newline at end of file diff --git a/howtos/index.md b/howtos/index.md deleted file mode 100644 index e421dee..0000000 --- a/howtos/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -layout: page -title: How-To Anleitungen -lang: de ---- - -# How-To Anleitungen - -Hier finden Sie detaillierte Schritt-für-Schritt Anleitungen für spezifische Aufgaben in Trailmarks.io. - -## Verfügbare Anleitungen - -### 📁 [Trail mit GPS-Daten importieren](import-gps-data) -Schritt-für-Schritt Anleitung zum Importieren von GPX-Dateien und anderen GPS-Formaten. - -**Was Sie lernen:** -- GPX-Dateien vorbereiten -- Import-Prozess durchführen -- Import-Einstellungen konfigurieren -- Häufige Probleme lösen - -## Geplante Anleitungen - -- 📤 **Trail-Daten exportieren** - Export in verschiedene Formate -- 📍 **POI (Points of Interest) verwalten** - Interessante Punkte hinzufügen -- 🗺️ **Offline-Karten nutzen** - Trails offline verwenden -- 👥 **Trails mit anderen teilen** - Freigabe und Collaboration -- 📊 **Statistiken und Berichte** - Auswertung Ihrer Aktivitäten -- 🔧 **API-Integration** - Entwickler-Integration - -## Weitere Ressourcen - -- 📖 [Benutzerhandbuch](/user-guide/) - Vollständige Dokumentation -- ❓ [FAQ](/faq/) - Häufig gestellte Fragen -- 🏗️ [Architektur](/architecture/) - Technische Details - -## Beitrag leisten - -Haben Sie eine Idee für eine neue Anleitung? Erstellen Sie ein Issue in unserem [GitHub Repository](https://github.com/trailmarks-io/docs/issues). - ---- - -*Letzte Aktualisierung: {{ site.time | date: "%d.%m.%Y" }}* \ No newline at end of file diff --git a/user-guide/index.md b/user-guide/index.md deleted file mode 100644 index 6973425..0000000 --- a/user-guide/index.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -layout: page -title: Benutzerhandbuch -lang: de ---- - -# Benutzerhandbuch - -Willkommen im Benutzerhandbuch für Trailmarks.io! Hier finden Sie alle Informationen, die Sie für die erfolgreiche Nutzung der Anwendung benötigen. - -## Verfügbare Dokumente - -### 📖 [Vollständiges Benutzerhandbuch](user-guide) -Umfassende Anleitung zur Nutzung von Trailmarks.io, von der Registrierung bis zu erweiterten Funktionen. - -**Inhalte:** -- Erste Schritte und Kontoerstellung -- Dashboard-Übersicht -- Trail-Management -- Navigation und Karten -- Erweiterte Funktionen -- Problembehandlung - -## Weitere Hilfsquellen - -- 🛠️ [How-To Anleitungen](/howtos/) - Schritt-für-Schritt Anleitungen -- ❓ [FAQ](/faq/) - Häufig gestellte Fragen -- 🏗️ [Architektur](/architecture/) - Technische Dokumentation - -## Unterstützung - -Falls Sie weitere Hilfe benötigen: - -- **E-Mail**: support@trailmarks.io -- **Community Forum**: https://community.trailmarks.io -- **GitHub Issues**: https://github.com/trailmarks-io/docs/issues - ---- - -*Letzte Aktualisierung: {{ site.time | date: "%d.%m.%Y" }}* \ No newline at end of file