docs: reorganize site structure using Diátaxis framework
- Group hub-documentation into explanation/, how-to/, and reference/ per Diátaxis - Move ifs-integration.md to new hoist-hub/ category - Add contributing/ category with Diátaxis framework explainer - Move tutorial-basics and tutorial-extras under docusaurus-guide/ - Rewrite docs/intro.mdx as site entry point with category navigation - Update all doc titles to reflect their Diátaxis type - Add HOIST logo to homepage hero and fix Get Started link
This commit is contained in:
1 parent
2cfb6f5ef7
commit
b9a194f7c5
44 files changed
+200
-63
No files matched your search
+23
-25
@@ -1,47 +1,45 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
title: Welcome
|
||||
---
|
||||
|
||||
# Tutorial Intro
|
||||
# HOIST HUB Docs
|
||||
|
||||
Let's discover **Docusaurus in less than 5 minutes**.
|
||||
This site is the central reference for everyone involved in designing, documenting, and delivering HOIST HUB features — Business Analysts, Developers, and Project Managers.
|
||||
|
||||
## Getting Started
|
||||
Use the sections below to find what you need.
|
||||
|
||||
Get started by **creating a new site**.
|
||||
---
|
||||
|
||||
Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**.
|
||||
## [HOIST HUB](/docs/hoist-hub/ifs-integration)
|
||||
|
||||
### What you'll need
|
||||
Technical documentation for the HOIST HUB platform itself.
|
||||
|
||||
- [Node.js](https://nodejs.org/en/download/) version 20.0 or above:
|
||||
- When installing Node.js, you are recommended to check all checkboxes related to dependencies.
|
||||
- **IFS Integration Architecture** — How HOIST HUB communicates with IFS via the generic wrapper module, including available server actions and key data structures
|
||||
|
||||
## Generate a new site
|
||||
---
|
||||
|
||||
Generate a new Docusaurus site using the **classic template**.
|
||||
## [HOIST HUB Documentation Standard](/docs/hub-documentation/explanation/purpose)
|
||||
|
||||
The classic template will automatically be added to your project after you run the command:
|
||||
The standard that defines how HUB specs are written, structured, and approved. If you are authoring or reviewing a HUB spec, start here.
|
||||
|
||||
```bash
|
||||
npm init docusaurus@latest my-website classic
|
||||
```
|
||||
- **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
|
||||
|
||||
You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.
|
||||
---
|
||||
|
||||
The command also installs all necessary dependencies you need to run Docusaurus.
|
||||
## [Contributing](/docs/contributing/diataxis-framework)
|
||||
|
||||
## Start your site
|
||||
Guidelines for anyone adding or maintaining content on this site.
|
||||
|
||||
Run the development server:
|
||||
- **Documentation Framework (Diátaxis)** — The framework used to organize this site and how to apply it when creating new documentation
|
||||
|
||||
```bash
|
||||
cd my-website
|
||||
npm run start
|
||||
```
|
||||
---
|
||||
|
||||
The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.
|
||||
## [Docusaurus Guide](/docs/docusaurus-guide/intro)
|
||||
|
||||
The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.
|
||||
Learn how to work with Docusaurus — the tool that powers this site.
|
||||
|
||||
- Create pages, write docs, manage versions, and deploy the site
|
||||
|
||||
Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.
|
||||
Reference in new issue
Block a user