Merged
Conversation
Co-authored-by: Knerio <96529060+Knerio@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update documentation for better clarity and coverage
Add comprehensive GLS Action documentation
Mar 19, 2026
Knerio
approved these changes
Mar 19, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The existing docs were minimal stubs. This PR adds full reference documentation covering all GLS Action capabilities, with correct conceptual framing of the Hercules platform primitives (events vs functions).
New pages
overview.md— What the action does, prerequisites (Aquila + GLS portal credentials), architecture and data flow diagramsquick-start.md— Hello World flow: build address → shipment unit → printing options → create shipment → consume responseevents.md— Correctly documents events as action-initiated triggers dispatched to Aquila (viaregisterFlowTypes+dispatchEvent) that start flows, not function outputs. GLS currently has no events; planned ones (gls.shipment.arrived,.delivered,.failed,.returned) are documented with their expected payload shapes and SDK registration patternfunctions.md— All 26 functions (5 builders, 14 shipment creators, 7 API ops) with signatures, parameter tables, constraints, and data flow diagramstypes.md— All 24 registered types with field-level reference tables, constraint annotations, and a type dependency diagramuse-cases.md— 8 end-to-end flow examples: standard delivery, validate-then-create, return shipment, identity-verified delivery, end-of-day reconciliation, label reprint, allowed services query, Saturday expresstroubleshooting.md— FAQ grouped by area, error code reference table, contribution guidemeta.json— Navigation order for the GLS docs sectionImproved pages
README.md— Rewritten: available actions table, base ENV vars, quick start steps, doc linksdocs/index.mdx— Prerequisites, actions table, quick links hubdocs/Guides/installation.md— Full step-by-step replacing the stub: ENV table, example.env, verification, update and troubleshooting stepsdocs/Actions/GLS/configs.md— Full config reference, step-by-step GLS Developer Portal credential guide, OAuth2 token flow diagram, default shipper explanationKey conceptual correction
The events page was initially drafted incorrectly (treating function return values as events). Corrected: events flow action → Aquila → flow, not the other way around.
⚡ Quickly spin up Copilot coding agent tasks from anywhere on your macOS or Windows machine with Raycast.