docs: add comprehensive workflow documentation with german translations by EPajares · Pull Request #3665 · plan4better/goat

EPajares · 2026-03-10T16:11:47Z

Description

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Related Issue

Copilot

Pull request overview

This PR adds comprehensive workflow documentation to the GOAT docs (both English and German), updates the map interface documentation to reflect UI changes, and reorganizes the documentation sidebar ordering to accommodate the new Workflows section.

Changes:

Adds new English and German documentation for the Workflow Interface, Workflow Variables, and Custom SQL features, along with supporting icon images and screenshot assets
Updates the Map Interface and Layers documentation (EN + DE) to reflect a redesigned panel structure (new Layers Panel, Tools section, Editing Panel), and updates icon references from compass-drafting.png to compass.png
Reorganizes sidebar positions across multiple categories and adds workflow-related terms to the GOAT UI glossary

Reviewed changes

Copilot reviewed 20 out of 52 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
`apps/docs/docs/workflows/workflow_interface.md`	New English workflow interface documentation
`apps/docs/docs/workflows/variables.md`	New English workflow variables documentation
`apps/docs/docs/workflows/custom_sql.md`	New English custom SQL documentation
`apps/docs/docs/workflows/_category_.json`	Workflows category config at position 4
`apps/docs/i18n/de/.../workflows/workflow_interface.md`	German translation of workflow interface
`apps/docs/i18n/de/.../workflows/variables.md`	German translation of variables doc
`apps/docs/i18n/de/.../workflows/custom_sql.md`	German translation of custom SQL doc
`apps/docs/i18n/de/.../workflows/_category_.json`	German workflows category config
`apps/docs/docs/map/map_interface.md`	Restructured map interface with new panels/tools layout
`apps/docs/docs/map/layers.md`	Updated layers management with group layers feature
`apps/docs/i18n/de/.../map/map_interface.md`	Partial German map interface update (Layer Panel only)
`apps/docs/i18n/de/.../map/layers.md`	German layers update with group layers
`apps/docs/docs/getting_started/quickstart_guide.md`	Updated quickstart to reflect new UI layout
`apps/docs/i18n/de/.../getting_started/quickstart_guide.md`	German quickstart update
`apps/docs/docs/data/data_types.md`	Updated image reference for view data
`apps/docs/docs/Scenarios/Scenarios.md`	Updated icon and sidebar position
`apps/docs/docs/nerdy_content/GOAT_ui_glossary.md`	Added workflow-related glossary terms
`apps/docs/docs/builder/_category_.json`	Position changed from 4 to 6
`apps/docs/docs/sharing/_category_.json`	Position changed from 5 to 8
`apps/docs/docs/routing/_category_.json`	Position changed from 7 to 9
Various icon `.png` files	New icon assets for workflow toolbar buttons
Various `.webp` screenshot files	Updated/new screenshots for interface documentation

You can also share your feedback on Copilot code review. Take the survey.

Copilot · 2026-03-10T16:24:05Z

apps/docs/i18n/de/docusaurus-plugin-content-docs/current/workflows/workflow_interface.md

+
+**Workflows** in GOAT bieten ein mächtiges visuelles Automatisierungssystem zur Erstellung anspruchsvoller räumlicher Analysepipelines. Anstatt einzelne Werkzeuge nacheinander auszuführen, können Sie mehrere Analyseschritte mit einer Drag-and-Drop-Leinwand verbinden und dabei eine automatisierte Datenverarbeitung erstellen, die wiederholende manuelle Arbeit eliminiert.
+
+Die Workflows können bei verschiedenen Datensätzen und Szenarien wiederverwendet werden. Jeder Workflow besteht aus verschiedenen Arten von [Knoten](../further_reading/glossary.md#knoten), die durch [Kanten](../further_reading/glossary.md#kanten) verbunden sind, und ermöglicht Ihnen:


Same as the English version, multiple glossary anchors referenced in this German translation don't exist in the German glossary (apps/docs/i18n/de/.../further_reading/glossary.md):

../further_reading/glossary.md#knoten (line 9)

../further_reading/glossary.md#kanten (line 9)

../further_reading/glossary.md#workflow (line 142)

These anchors need to be added to the German glossary.

Suggested change

Die Workflows können bei verschiedenen Datensätzen und Szenarien wiederverwendet werden. Jeder Workflow besteht aus verschiedenen Arten von [Knoten](../further_reading/glossary.md#knoten), die durch [Kanten](../further_reading/glossary.md#kanten) verbunden sind, und ermöglicht Ihnen:

Die Workflows können bei verschiedenen Datensätzen und Szenarien wiederverwendet werden. Jeder Workflow besteht aus verschiedenen Arten von [Knoten](../further_reading/glossary.md), die durch [Kanten](../further_reading/glossary.md) verbunden sind, und ermöglicht Ihnen:

Copilot · 2026-03-10T16:24:06Z

apps/docs/i18n/de/docusaurus-plugin-content-docs/current/workflows/custom_sql.md

+Das **Benutzerdefinierte SQL**-Werkzeug ermöglicht es Ihnen, benutzerdefinierte SQL-Abfragen für Datenanalysen direkt innerhalb Ihrer [Workflows](../further_reading/glossary.md#workflows) zu schreiben. Diese mächtige Funktion ermöglicht erweiterte Datenverarbeitung, die über GOATs eingebaute Werkzeuge hinausgeht.
+
+## Übersicht
+
+Das Benutzerdefinierte SQL-Werkzeug verbindet sich mit GOATs [DuckDB](../further_reading/glossary.md#duckdb) Backend und gibt Ihnen direkten Zugriff auf die Abfrage Ihrer Datensätze mit SQL-Syntax. Sie können:


Multiple glossary anchors referenced here don't exist in the German glossary:

../further_reading/glossary.md#workflows (line 3, 7)

../further_reading/glossary.md#duckdb (line 11)

../further_reading/glossary.md#datensatz-knoten (line 30)

../further_reading/glossary.md#temporäre-ebene (line 172)

../further_reading/glossary.md#export-knoten (line 175)

These anchors need to be added to the German glossary, or the links should be removed.

links removed

Copilot · 2026-03-10T16:24:06Z

apps/docs/docs/workflows/custom_sql.md

+### Query Validation
+
+<div class="step">
+  <div class="step-number">1</div>
+  <div class="content"><strong>Syntax Check</strong>: The editor highlights syntax errors as you type.</div>
+</div>
+
+<div class="step">
+  <div class="step-number">2</div>
+  <div class="content"><strong>Preview Results</strong>: Use the <code>Preview</code> button to see the first few rows of results.</div>
+</div>


The English version of the Query Validation section has only 2 steps (Syntax Check, Preview Results), while the German translation has 3 steps including a "Validate query" step (clicking a Validate button). The German version also includes a "Configuration Options" section (Query Timeout, Result Limit, Column Types at lines 94-100) that is completely absent from the English version. The English and German versions should be consistent — either add the missing content to the English version or remove it from the German version.

Removed from german version

Copilot · 2026-03-10T16:24:06Z

apps/docs/i18n/de/docusaurus-plugin-content-docs/current/map/layers.md

+:::tip Technische Dokumentation
+
+Für detaillierte Informationen über die zugrundeliegenden Prozesse und Werkzeuge besuchen Sie bitte die **Prozesse API** im **Geoapi Ordner**. Weitere Low-Level-Werkzeugbeschreibungen finden Sie auch in der **goatlib** im Packages-Verzeichnis.
+
+::: 
+



This "Technical Documentation" tip references internal code structure ("Prozesse API im Geoapi Ordner", "goatlib im Packages-Verzeichnis") which is inappropriate for end-user documentation. It exposes internal repository structure to users who wouldn't have access to the codebase. Additionally, this tip doesn't exist in the corresponding English version of layers.md, creating a discrepancy between translations. This tip should be removed.

Suggested change

:::tip Technische Dokumentation

Für detaillierte Informationen über die zugrundeliegenden Prozesse und Werkzeuge besuchen Sie bitte die **Prozesse API** im **Geoapi Ordner**. Weitere Low-Level-Werkzeugbeschreibungen finden Sie auch in der **goatlib** im Packages-Verzeichnis.

:::

Copilot · 2026-03-10T16:24:07Z

apps/docs/docs/workflows/variables.md

+
+### In Tool Parameters
+
+Variables can be used in most many configuration fields:


"most many" is grammatically incorrect — it should be either "most" or "many", not both. For example: "Variables can be used in many configuration fields" or "Variables can be used in most configuration fields".

Suggested change

Variables can be used in most many configuration fields:

Variables can be used in most configuration fields:

no need to change

Copilot · 2026-03-10T16:24:07Z

apps/docs/docs/workflows/workflow_interface.md

+
+**Workflows** in GOAT provide a powerful visual automation system for creating sophisticated spatial analysis pipelines. Instead of running individual tools sequentially, you can connect multiple analysis steps together using a drag-and-drop canvas, creating an automated data processing that eliminates repetitive manual work.
+
+The workflows can be reused across different datasets and scenarios. Each workflow consists of different types of [nodes](../further_reading/glossary.md#node) connected by [edges](../further_reading/glossary.md#edge), enabling you to:


Multiple glossary anchors referenced throughout the new workflow documentation don't exist in the glossary page (apps/docs/docs/further_reading/glossary.md). The following links will be broken:

../further_reading/glossary.md#node (line 9)

../further_reading/glossary.md#edge (line 9)

../further_reading/glossary.md#workflow (line 144)

../further_reading/glossary.md#temporary-layer (line 159)

../further_reading/glossary.md#export-node (line 162)

These anchors need to be added to the glossary, or the links should be removed/replaced.

Suggested change

The workflows can be reused across different datasets and scenarios. Each workflow consists of different types of [nodes](../further_reading/glossary.md#node) connected by [edges](../further_reading/glossary.md#edge), enabling you to:

The workflows can be reused across different datasets and scenarios. Each workflow consists of different types of [nodes](../further_reading/glossary.md) connected by [edges](../further_reading/glossary.md), enabling you to:

links removed

Copilot · 2026-03-10T16:24:07Z

apps/docs/docs/workflows/custom_sql.md

+The Custom SQL tool creates a new [temporary layer](../further_reading/glossary.md#temporary-layer) containing your query results. You can:
+
+- Connect the output to other workflow tools for further analysis
+- Add an [export node](../further_reading/glossary.md#export-node) to save results as a permanent dataset


The Custom SQL doc references several glossary anchors that don't exist in the glossary (apps/docs/docs/further_reading/glossary.md):

../further_reading/glossary.md#temporary-layer (line 159)

../further_reading/glossary.md#export-node (line 162)

Additionally, the DuckDB backend is mentioned in the Overview but there's no glossary entry for it, unlike the corresponding German version which links to glossary.md#duckdb. These should be added to the glossary or the links adjusted.

Suggested change

The Custom SQL tool creates a new [temporary layer](../further_reading/glossary.md#temporary-layer) containing your query results. You can:

- Connect the output to other workflow tools for further analysis

- Add an [export node](../further_reading/glossary.md#export-node) to save results as a permanent dataset

The Custom SQL tool creates a new [temporary layer](../further_reading/glossary.md) containing your query results. You can:

- Connect the output to other workflow tools for further analysis

- Add an [export node](../further_reading/glossary.md) to save results as a permanent dataset

removed links

Copilot · 2026-03-10T16:24:08Z

apps/docs/docs/map/map_interface.md

+- <img src={require('/img/icons/compass.png').default} alt="Scenarios" style={{ maxHeight: "20px", maxWidth: "20px", objectFit: "cover"}}/> <code>Scenarios</code>: <strong>Access to Scenarios</strong>. Read more in <a href="/category/scenarios">Scenarios</a>.

+-  <img src={require('/img/icons/ruler-horizontal.png').default} alt="Measurements" style={{ maxHeight: "20px", maxWidth: "20px", objectFit: "cover"}}/> <code>Measurements</code>: Users can <strong>measure distances and areas</strong>, such as routes, lines and polygons.
+Read more in <a href="/category/measurements">Measurements</a>.


The link <a href="/category/measurements">Measurements</a> points to a category page that doesn't exist — there is no measurements directory with a _category_.json file in the docs. This will result in a broken link. Either create the measurements category/documentation or link to an existing page instead.

Suggested change

Read more in <a href="/category/measurements">Measurements</a>.

Read more in the Measurements section.

Removed redundant line about Measurements.

Removed steps for previewing results and configuration options from the custom SQL documentation.

Removed technical documentation tip and related content.

github-actions · 2026-03-11T10:45:31Z

Thank you for following the naming conventions! 🙏

cnarbaitzsarsur

Review done.

docs: add comprehensive workflow documentation with german translations

938ed75

Copilot AI review requested due to automatic review settings March 10, 2026 16:11

Copilot started reviewing on behalf of EPajares March 10, 2026 16:14 View session

Copilot AI reviewed Mar 10, 2026

View reviewed changes

cnarbaitzsarsur added 5 commits March 11, 2026 11:29

Clean up Measurements section in map_interface.md

ed1b5fb

Removed redundant line about Measurements.

Update custom_sql.md to remove unnecessary sections

2cfaa5e

Removed steps for previewing results and configuration options from the custom SQL documentation.

Fix formatting and improve clarity in custom_sql.md

b13b9c7

Eliminate links to non-existant pages

a9725ba

Remove technical documentation section from layers.md

b0d3f81

Removed technical documentation tip and related content.

Eliminate links to non-existant pages

37321bf

cnarbaitzsarsur approved these changes Mar 11, 2026

View reviewed changes

EPajares merged commit d5dc3be into plan4better:main Mar 11, 2026
10 of 12 checks passed


		Workflows in GOAT bieten ein mächtiges visuelles Automatisierungssystem zur Erstellung anspruchsvoller räumlicher Analysepipelines. Anstatt einzelne Werkzeuge nacheinander auszuführen, können Sie mehrere Analyseschritte mit einer Drag-and-Drop-Leinwand verbinden und dabei eine automatisierte Datenverarbeitung erstellen, die wiederholende manuelle Arbeit eliminiert.

		Die Workflows können bei verschiedenen Datensätzen und Szenarien wiederverwendet werden. Jeder Workflow besteht aus verschiedenen Arten von [Knoten](../further_reading/glossary.md#knoten), die durch [Kanten](../further_reading/glossary.md#kanten) verbunden sind, und ermöglicht Ihnen:


		### In Tool Parameters

		Variables can be used in most many configuration fields:

	Variables can be used in most many configuration fields:
	Variables can be used in most configuration fields:


		Workflows in GOAT provide a powerful visual automation system for creating sophisticated spatial analysis pipelines. Instead of running individual tools sequentially, you can connect multiple analysis steps together using a drag-and-drop canvas, creating an automated data processing that eliminates repetitive manual work.

		The workflows can be reused across different datasets and scenarios. Each workflow consists of different types of [nodes](../further_reading/glossary.md#node) connected by [edges](../further_reading/glossary.md#edge), enabling you to:

	Read more in <a href="/category/measurements">Measurements</a>.
	Read more in the Measurements section.

Conversation

EPajares commented Mar 10, 2026

Description

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Related Issue

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

cnarbaitzsarsur Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

cnarbaitzsarsur Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

cnarbaitzsarsur Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

cnarbaitzsarsur Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

cnarbaitzsarsur Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

cnarbaitzsarsur Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Mar 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cnarbaitzsarsur left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions bot commented Mar 11, 2026 •

edited

Loading