Main Page: Difference between revisions
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | |||
= LogiStack Documentation = | |||
Welcome to the LogiStack knowledge base. This private wiki contains how-tos, admin guides, and integration docs for the LogiStack platform (driver app, admin tools, and API). | |||
== Getting started == | == Quick links == | ||
* [ | {| class="wikitable" style="width:100%" | ||
! Area !! Page !! What you’ll find | |||
* | |- | ||
* [ | | Getting started || [[Getting started]] || Account access, environments, and first steps | ||
* [ | |- | ||
| Driver app || [[Driver App Guide]] || Install, sign-in, jobs, tracking, and POD | |||
|- | |||
| Admin portal || [[Admin Guide]] || Assign jobs, live map, POD images, user management | |||
|- | |||
| API || [[API Reference]] || Auth, endpoints, request/response examples | |||
|- | |||
| FAQ || [[FAQ]] || Short answers to common questions | |||
|- | |||
| Troubleshooting || [[Troubleshooting]] || Error messages, checklists, and known fixes | |||
|- | |||
| Release notes || [[Release notes/2025]] || What’s new, changes, and fixes | |||
|} | |||
== Start here == | |||
If you’re new to LogiStack, follow these steps: | |||
# Read [[Getting started]] (access, environments, roles). | |||
# If you’re a **driver**, go to [[Driver App Guide]] and complete the setup checklist. | |||
# If you’re an **admin/manager**, see [[Admin Guide]] for job assignment, live tracking, and POD review. | |||
# If you integrate with other systems, see [[API Reference]]. | |||
== Roles & responsibilities == | |||
; Drivers | |||
: Use the mobile app to view/accept jobs, update statuses, and upload Proof of Delivery (POD). See [[Driver App Guide]]. | |||
; Admins/Managers | |||
: Assign jobs, monitor live locations, and manage PODs and users. See [[Admin Guide]]. | |||
; Integrators | |||
: Connect external systems via the API. See [[API Reference]]. | |||
== Environments == | |||
* **Production:** `https://api.yourdomain.co.uk/api` | |||
* **Staging (if applicable):** `https://staging-api.yourdomain.co.uk/api` | |||
See [[Getting started#Environments]] for current URLs and credentials policy. | |||
== Operational runbook == | |||
* [[Troubleshooting]] — common issues and quick checks | |||
* [[Admin Guide#Live Map]] — verifying vehicle location data | |||
* [[Admin Guide#POD images]] — locating, reviewing, and exporting PODs | |||
* [[Release notes/2025]] — recent updates you may need to communicate | |||
== Support == | |||
* Internal support process: see [[Support workflow]] | |||
* Severity levels: S1–S4 (defined in [[Support workflow#Severities]]) | |||
* Open a ticket: Use the private support repository (see [[Support workflow#Opening a ticket]]) | |||
== Policies == | |||
* [[Security & privacy]] — handling data, credentials, and devices | |||
* [[Change management]] — how we roll out app/API changes | |||
* [[Style guide]] — how to write docs here | |||
== Search tips == | |||
* Use the **Search** box for page titles and text. | |||
* Narrow searches by quoting phrases, e.g., `"Start Tracking"` or `"custom-overrides.css"`. | |||
* Look at the bottom of pages for **Categories** to find related content. | |||
---- | |||
''This wiki is private to authorized users. Do not copy content externally without approval.'' | |||
Revision as of 02:15, 7 October 2025
LogiStack Documentation
Welcome to the LogiStack knowledge base. This private wiki contains how-tos, admin guides, and integration docs for the LogiStack platform (driver app, admin tools, and API).
Quick links
| Area | Page | What you’ll find |
|---|---|---|
| Getting started | Getting started | Account access, environments, and first steps |
| Driver app | Driver App Guide | Install, sign-in, jobs, tracking, and POD |
| Admin portal | Admin Guide | Assign jobs, live map, POD images, user management |
| API | API Reference | Auth, endpoints, request/response examples |
| FAQ | FAQ | Short answers to common questions |
| Troubleshooting | Troubleshooting | Error messages, checklists, and known fixes |
| Release notes | Release notes/2025 | What’s new, changes, and fixes |
Start here
If you’re new to LogiStack, follow these steps:
- Read Getting started (access, environments, roles).
- If you’re a **driver**, go to Driver App Guide and complete the setup checklist.
- If you’re an **admin/manager**, see Admin Guide for job assignment, live tracking, and POD review.
- If you integrate with other systems, see API Reference.
Roles & responsibilities
- Drivers
- Use the mobile app to view/accept jobs, update statuses, and upload Proof of Delivery (POD). See Driver App Guide.
- Admins/Managers
- Assign jobs, monitor live locations, and manage PODs and users. See Admin Guide.
- Integrators
- Connect external systems via the API. See API Reference.
Environments
- **Production:** `https://api.yourdomain.co.uk/api`
- **Staging (if applicable):** `https://staging-api.yourdomain.co.uk/api`
See Getting started#Environments for current URLs and credentials policy.
Operational runbook
- Troubleshooting — common issues and quick checks
- Admin Guide#Live Map — verifying vehicle location data
- Admin Guide#POD images — locating, reviewing, and exporting PODs
- Release notes/2025 — recent updates you may need to communicate
Support
- Internal support process: see Support workflow
- Severity levels: S1–S4 (defined in Support workflow#Severities)
- Open a ticket: Use the private support repository (see Support workflow#Opening a ticket)
Policies
- Security & privacy — handling data, credentials, and devices
- Change management — how we roll out app/API changes
- Style guide — how to write docs here
Search tips
- Use the **Search** box for page titles and text.
- Narrow searches by quoting phrases, e.g., `"Start Tracking"` or `"custom-overrides.css"`.
- Look at the bottom of pages for **Categories** to find related content.
This wiki is private to authorized users. Do not copy content externally without approval.