- Introduced new documentation for the DataHUB service, including purpose, roles, and business case. - Added detailed API reference for Quotes and Visits, including search endpoints and response structures. - Created sections for service records, time reports, and visits in the CustomerHUB documentation. - Implemented a change log and test plan for the DataHUB project. - Updated the introduction to include links to the new DataHUB documentation. - Modified navbar configuration to reflect changes in documentation structure.
65 lines
2.3 KiB
Plaintext
65 lines
2.3 KiB
Plaintext
---
|
|
sidebar_position: 1
|
|
title: Welcome
|
|
---
|
|
|
|
# HOIST HUB Docs
|
|
|
|
This site is the central reference for everyone involved in designing, documenting, and delivering HOIST HUB features — Business Analysts, Developers, and Project Managers.
|
|
|
|
Use the sections below to find what you need.
|
|
|
|
---
|
|
|
|
## [CustomerHUB](/docs/customerhub/explanation/what-is-customerhub)
|
|
|
|
User documentation for the CustomerHUB application — the operational portal built on HOIST HUB.
|
|
|
|
- **Explanation** — What CustomerHUB is and how it connects to IFS
|
|
- **Reference** — Field-by-field documentation for Dashboard and Customers
|
|
- **How-to Guides** — Find a customer, import from IFS, and more
|
|
|
|
---
|
|
|
|
## [HOIST HUB](/docs/hoist-hub/ifs-integration)
|
|
|
|
Technical documentation for the HOIST HUB platform itself.
|
|
|
|
- **IFS Integration Architecture** — How HOIST HUB communicates with IFS via the generic wrapper module, including available server actions and key data structures
|
|
|
|
---
|
|
|
|
## [DataHUB](/docs/datahub/explanation/purpose-and-roles)
|
|
|
|
REST API for extracting HUB data — built for Martin Engineering as a self-service alternative to ad hoc data requests.
|
|
|
|
- **Explanation** — Purpose, roles, and the business case for the DataHUB service
|
|
- **Reference** — Solution design, dataset structures, API endpoints (Quotes/Search, Visits/Search), test plan, and delivery estimates
|
|
|
|
---
|
|
|
|
## [HOIST HUB Documentation Standard](/docs/hub-documentation/explanation/purpose)
|
|
|
|
The standard that defines how HUB specs are written, structured, and approved. If you are authoring or reviewing a HUB spec, start here.
|
|
|
|
- **Explanation** — Understand the purpose of the standard and the roles involved
|
|
- **How-to Guides** — Step-by-step guidance on documenting UI flows, mockups, and custom fields
|
|
- **Reference** — Templates for every section of a HUB spec: business requirements, functional and technical design, test plans, estimates, approvals, and change log
|
|
|
|
---
|
|
|
|
## [Contributing](/docs/contributing/diataxis-framework)
|
|
|
|
Guidelines for anyone adding or maintaining content on this site.
|
|
|
|
- **Documentation Framework (Diátaxis)** — The framework used to organize this site and how to apply it when creating new documentation
|
|
|
|
---
|
|
|
|
## [Docusaurus Guide](/docs/docusaurus-guide/intro)
|
|
|
|
Learn how to work with Docusaurus — the tool that powers this site.
|
|
|
|
- Create pages, write docs, manage versions, and deploy the site
|
|
|