928a4451f78128886f7ddefd53e9b74cd6fb9e7b
- 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.
HOIST HUB Docs
Technical documentation site for HOIST HUB implementations, built with Docusaurus 3.
Structured using the Diátaxis framework — how-to guides, reference material, and explanations live in dedicated sections.
Getting started
Requirements: Node.js 20+, pnpm
pnpm install
pnpm start
Opens a local dev server at http://localhost:3000 with live reload.
Available commands
| Command | Description |
|---|---|
pnpm start |
Start local dev server |
pnpm build |
Build static site to build/ |
pnpm serve |
Serve the production build locally |
pnpm typecheck |
Run TypeScript checks |
pnpm clear |
Clear Docusaurus cache |
Documentation structure
docs/
├── contributing/ # Doc standards and Diátaxis guide
├── hoist-hub/ # HOIST HUB product docs (IFS integration)
└── hub-documentation/ # Project docs organized by Diátaxis
├── explanation/ # Background and concepts
├── how-to/ # Task-oriented guides
└── reference/ # Requirements, technical design, test plans
Contributing
See docs/contributing/diataxis-framework.md for the documentation standard used in this project.
Languages
CSS
48.3%
TypeScript
31%
MDX
20.7%