Skip to content

Commit 28c8fcb

Browse files
nicosammitonicosammito
authored
Merge pull request #7 from code0-tech/feat/docs-layout
Update documentation titles for clarity and consistency
2 parents 610b240 + 6d3416a commit 28c8fcb

12 files changed

Lines changed: 59 additions & 48 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,13 @@ All actions share the following base environment variables, which connect them t
2727
4. Fill in your credentials and Hercules connection details in `.env`
2828
5. Start the action: `docker compose up -d`
2929

30-
See the [Installation Guide](docs/Guides/installation.md) for detailed steps.
30+
See the [Installation Guide](docs/installation.md) for detailed steps.
3131

3232
## Documentation
3333

3434
Full documentation is located in the [`docs/`](docs/) folder:
3535

36-
- [Installation Guide](docs/Guides/installation.md)
36+
- [Installation Guide](docs/installation.md)
3737
- [GLS Action Overview](docs/Actions/GLS/overview.md)
3838
- [GLS Configuration](docs/Actions/GLS/configs.md)
3939
- [GLS Functions](docs/Actions/GLS/functions.md)

‎docs/Actions/GLS/configs.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Action Configuration
2+
title: Configuration
33
description: All configuration options for the GLS Action, including how to obtain credentials from the GLS Developer Portal.
44
---
55

@@ -107,4 +107,4 @@ The value must be a valid `GLS_SHIPPER` object:
107107
}
108108
```
109109

110-
See [Types — GLS_SHIPPER](../GLS/types.md/#GLS_SHIPPER) for the full field reference.
110+
See [Types — GLS_SHIPPER](types.md#GLS_SHIPPER) for the full field reference.

‎docs/Actions/GLS/events.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: GLS Action Events
2+
title: Trigger
33
description: Events emitted by the GLS Action — what they are, how they trigger flows in Aquila, and what future events are planned.
44
---
55

‎docs/Actions/GLS/functions.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
title: GLS Action Functions
2+
title: Functions
33
description: All functions available in the GLS Action with detailed descriptions, parameters, and data flow diagrams.
44
---
55

6-
# GLS Action Functions
6+
# Functions
77

88
The GLS Action exposes **26 functions** grouped into three categories:
99

@@ -56,7 +56,7 @@ createAddress(
5656
| `MobilePhonenumber` | string (min 4, max 35) | No | Mobile phone number |
5757
| `eMail` | string (max 80) | No | Email address |
5858

59-
**Returns:** [`GLS_ADDRESS`](../GLS/types.md#GLS_ADDRESS)
59+
**Returns:** [`GLS_ADDRESS`](types.md#GLS_ADDRESS)
6060

6161
---
6262

@@ -83,7 +83,7 @@ createConsignee(
8383
| `Address` | GLS_ADDRESS | **Yes** | The delivery address for this consignee |
8484
| `Category` | `"BUSINESS"` \| `"PRIVATE"` | **Yes** | Whether the consignee is a business or private recipient |
8585

86-
**Returns:** [`GLS_CONSIGNEE`](../GLS/types.md#GLS_CONSIGNEE)
86+
**Returns:** [`GLS_CONSIGNEE`](types.md#GLS_CONSIGNEE)
8787

8888
---
8989

@@ -114,7 +114,7 @@ createShipmentUnit(
114114
| `note2` | string (max 50) | No | Additional note printed on the label (line 2) |
115115
| `shipmentUnitService` | GLS_UNIT_SERVICE | No | Unit-level services (Cash, AddonLiability, HazardousGoods, etc.) |
116116

117-
**Returns:** [`GLS_SHIPMENT_UNIT`](../GLS/types.md#GLS_SHIPMENT_UNIT)
117+
**Returns:** [`GLS_SHIPMENT_UNIT`](types.md#GLS_SHIPMENT_UNIT)
118118

119119
---
120120

@@ -140,7 +140,7 @@ createPrintingOptions(returnLabels: RETURN_LABELS): GLS_PRINTING_OPTIONS
140140
| `TemplateSet` | `NONE`, `D_200`, `PF_4_I`, `ZPL_200`, `ZPL_300`, ... | Label template set |
141141
| `LabelFormat` | `PDF`, `ZEBRA`, `INTERMEC`, `DATAMAX`, `TOSHIBA`, `PNG` | Output format |
142142

143-
**Returns:** [`GLS_PRINTING_OPTIONS`](../GLS/types.md#GLS_PRINTING_OPTIONS)
143+
**Returns:** [`GLS_PRINTING_OPTIONS`](types.md#GLS_PRINTING_OPTIONS)
144144

145145
---
146146

@@ -169,7 +169,7 @@ createCustomContent(
169169
| `barcodeType` | `"EAN_128"` \| `"CODE_39"` | No | Barcode symbology |
170170
| `barcode` | string | No | Custom barcode value |
171171

172-
**Returns:** [`GLS_CUSTOM_CONTENT`](../GLS/types.md#GLS_CUSTOM_CONTENT)
172+
**Returns:** [`GLS_CUSTOM_CONTENT`](types.md#GLS_CUSTOM_CONTENT)
173173

174174
---
175175

@@ -536,7 +536,7 @@ validateShipment
536536
└── validationResult.Issues[]
537537
```
538538

539-
See [Types — GLS_VALIDATE_SHIPMENT_REQUEST_DATA](../GLS/types.md#GLS_VALIDATE_SHIPMENT_REQUEST_DATA) for the input format.
539+
See [Types — GLS_VALIDATE_SHIPMENT_REQUEST_DATA](types.md#GLS_VALIDATE_SHIPMENT_REQUEST_DATA) for the input format.
540540

541541
---
542542

‎docs/Actions/GLS/meta.json‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,16 @@
22
"title": "GLS Action",
33
"description": "GLS ShipIT integration for creating and managing shipments",
44
"pages": [
5+
"---Introduction---",
56
"overview",
67
"quick-start",
78
"configs",
9+
"troubleshooting",
10+
"---Definitions---",
811
"events",
912
"functions",
1013
"types",
11-
"use-cases",
12-
"troubleshooting"
14+
"---Use Cases---",
15+
"use-cases"
1316
]
1417
}

‎docs/Actions/GLS/overview.md‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
2-
title: GLS Action Overview
2+
title: Overview
33
description: Overview of the GLS ShipIT action — what it does, what you need to get started, and how it fits into your flows.
4+
icon: IconHome
45
---
56

67
# GLS Action
@@ -87,10 +88,10 @@ GLS_CREATE_PARCELS_RESPONSE ← tracking IDs, barcode data, print data, routing
8788

8889
## Next steps
8990

90-
- [Quick Start](../GLS/quick-start.md) — Create your first shipment in a few steps
91-
- [Configuration](../GLS/configs.md) — Full list of configuration options and how to get credentials
92-
- [Functions](../GLS/functions.md) — All available functions with parameter details
93-
- [Types](../GLS/types.md) — All data types used in the GLS Action
94-
- [Events](../GLS/events.md) — Events emitted by the GLS Action
95-
- [Common Use Cases](../GLS/use-cases.md) — Example flows for real-world scenarios
96-
- [Troubleshooting](../GLS/troubleshooting.md) — FAQ and community support
91+
- [Quick Start](quick-start.md) — Create your first shipment in a few steps
92+
- [Configuration](configs.md) — Full list of configuration options and how to get credentials
93+
- [Functions](functions.md) — All available functions with parameter details
94+
- [Types](types.md) — All data types used in the GLS Action
95+
- [Events](events.md) — Events emitted by the GLS Action
96+
- [Common Use Cases](use-cases.md) — Example flows for real-world scenarios
97+
- [Troubleshooting](troubleshooting.md) — FAQ and community support

‎docs/Actions/GLS/quick-start.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Quick Start — GLS Action
2+
title: Quick Start
33
description: Create your first GLS shipment in a few steps.
44
---
55

@@ -11,7 +11,7 @@ This guide walks you through creating your first GLS shipment using the GLS Acti
1111

1212
## Step 1: Install and configure the action
1313

14-
Follow the [Installation Guide](../../Guides/installation.md) to deploy the GLS Action, then set the following configuration values in your Hercules admin panel (or `.env` file):
14+
Follow the [Installation Guide](../../installation.md) to deploy the GLS Action, then set the following configuration values in your Hercules admin panel (or `.env` file):
1515

1616
| Config | Value |
1717
|-------------------|--------------------------------------------------------------------------------------|
@@ -20,7 +20,7 @@ Follow the [Installation Guide](../../Guides/installation.md) to deploy the GLS
2020
| `ship_it_api_url` | GLS ShipIT endpoint (default: `https://api.gls-group.net/shipit-farm/v1/backend/rs`) |
2121
| `auth_url` | GLS auth endpoint (default: `https://api.gls-group.net/oauth2/v2/token`) |
2222

23-
See [Configuration](./configs.md) for the full list of options and how to obtain credentials.
23+
See [Configuration](configs.md) for the full list of options and how to obtain credentials.
2424

2525
---
2626

@@ -128,7 +128,7 @@ The `GLS_CREATE_PARCELS_RESPONSE` contains everything you need:
128128

129129
## Common next steps
130130

131-
- [Validate before creating](./functions.md#validateShipment) — Call `validateShipment` first to catch errors before committing
132-
- [Cancel a shipment](./functions.md#cancelShipment) — Use `cancelShipment` with the `TrackID` if something changes
133-
- [Reprint a label](./functions.md#reprintParcel) — Use `reprintParcel` if a label is lost or damaged
134-
- [Common Use Cases](./use-cases.md) — End-to-end examples for real-world scenarios
131+
- [Validate before creating](functions.md#validateShipment) — Call `validateShipment` first to catch errors before committing
132+
- [Cancel a shipment](functions.md#cancelShipment) — Use `cancelShipment` with the `TrackID` if something changes
133+
- [Reprint a label](functions.md#reprintParcel) — Use `reprintParcel` if a label is lost or damaged
134+
- [Common Use Cases](use-cases.md) — End-to-end examples for real-world scenarios

‎docs/Actions/GLS/troubleshooting.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Troubleshooting & Community Support
2+
title: Troubleshooting
33
description: Frequently asked questions, troubleshooting tips, and community resources for the GLS Action.
44
---
55

@@ -30,7 +30,7 @@ A: The action supports all major GLS shipment types and services, including:
3030
- Tyre service, addressee-only delivery
3131
- Saturday and next-working-day delivery (EXPRESS only)
3232

33-
See [Functions](../GLS/functions.md) for the complete list.
33+
See [Functions](functions.md) for the complete list.
3434

3535
---
3636

‎docs/Actions/GLS/types.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: GLS Action Types
2+
title: Datatypes
33
description: All data types registered by the GLS Action — field references and descriptions.
44
---
55

‎docs/index.mdx‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Welcome to the Documentation for Centaurus
2+
title: Action SDK
33
description: Find out how Centaurus works
44
template: splash
55
---
@@ -27,17 +27,17 @@ Before using any action from Centaurus, make sure you have:
2727

2828
| Action | Description | Status |
2929
|--------|-------------|--------|
30-
| [GLS](./Actions/GLS/overview.md) | GLS ShipIT integration for creating and managing shipments | ✅ Available |
30+
| [GLS](Actions/GLS/overview.md) | GLS ShipIT integration for creating and managing shipments | ✅ Available |
3131

3232
---
3333

3434
## Quick Links
3535

36-
- [Installation Guide](./Guides/installation.md) — How to deploy an action on your self-hosted instance
37-
- [GLS Action Overview](./Actions/GLS/overview.md) — Get started with the GLS shipping integration
38-
- [GLS Configuration](./Actions/GLS/configs.md) — API keys and configuration options
39-
- [GLS Functions](./Actions/GLS/functions.md) — All available functions and their parameters
40-
- [GLS Types](./Actions/GLS/types.md) — Data types used across the GLS action
41-
- [GLS Events](./Actions/GLS/events.md) — Events emitted by the GLS action
42-
- [Common Use Cases](./Actions/GLS/use-cases.md) — Example workflows using the GLS action
43-
- [Troubleshooting](./Actions/GLS/troubleshooting.md) — FAQ and community support
36+
- [Installation Guide](installation.md) — How to deploy an action on your self-hosted instance
37+
- [GLS Action Overview](Actions/GLS/overview.md) — Get started with the GLS shipping integration
38+
- [GLS Configuration](Actions/GLS/configs.md) — API keys and configuration options
39+
- [GLS Functions](Actions/GLS/functions.md) — All available functions and their parameters
40+
- [GLS Types](Actions/GLS/types.md) — Data types used across the GLS action
41+
- [GLS Events](Actions/GLS/events.md) — Events emitted by the GLS action
42+
- [Common Use Cases](Actions/GLS/use-cases.md) — Example workflows using the GLS action
43+
- [Troubleshooting](Actions/GLS/troubleshooting.md) — FAQ and community support

0 commit comments

Comments
 (0)