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.
43 lines
1.4 KiB
Markdown
43 lines
1.4 KiB
Markdown
# HOIST HUB Docs
|
|
|
|
Technical documentation site for HOIST HUB implementations, built with [Docusaurus 3](https://docusaurus.io/).
|
|
|
|
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
|
|
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`](docs/contributing/diataxis-framework.md) for the documentation standard used in this project.
|