docs: replace default README and clean up minor doc issues

Replace boilerplate Docusaurus README with project-specific content
covering the actual stack (pnpm), Diátaxis structure, and docs layout.
Also remove a stray danger admonition from ifs-integration.md and fix
logo filename reference in docusaurus.config.ts.
This commit is contained in:
jaime.meza committed 2026-06-22 08:16:54 -05:00
1 parent b9a194f7c5
commit d1251a5f05
3 files changed
+33 -36

No files matched your search

+32 -31
View File
@@ -1,41 +1,42 @@
# Website
# HOIST HUB Docs
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
Technical documentation site for HOIST HUB implementations, built with [Docusaurus 3](https://docusaurus.io/).
## Installation
Structured using the [Diátaxis framework](https://diataxis.fr/) — how-to guides, reference material, and explanations live in dedicated sections.
## Getting started
**Requirements:** Node.js 20+, pnpm
```bash
yarn
pnpm install
pnpm start
```
## Local Development
Opens a local dev server at `http://localhost:3000` with live reload.
```bash
yarn start
## 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
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
## Contributing
## Build
```bash
yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
## Deployment
Using SSH:
```bash
USE_SSH=true yarn deploy
```
Not using SSH:
```bash
GIT_USER=<Your GitHub username> yarn deploy
```
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
See [`docs/contributing/diataxis-framework.md`](docs/contributing/diataxis-framework.md) for the documentation standard used in this project.
-4
View File
@@ -5,10 +5,6 @@ title: IFS Integration Architecture
# Integration with IFS
:::danger
Documentation versioning with git
:::
Integration with IFS is a crucial part of HOIST Hub Design. Most HOIST HUB applications function in conjunction with or on top of IFS data sources. Therefore, tight IFS integration is required for most projects.
IFS integration is done via an **IFS Wrapper Module** that works as a low-code representation of the IFS Integration extension written in C#.
+1 -1
View File
@@ -78,7 +78,7 @@ const config: Config = {
title: 'HOIST HUB Docs',
logo: {
alt: 'HOIST Logo',
src: 'img/White Hoist Logo.avif',
src: 'img/hoist-logo.avif',
},
items: [
{