jarvis-at-skic
f39c2a1e5f
Build and Deploy Documentation / build (push) Failing after 1m24s
- Set up Docusaurus with pnpm and TypeScript - Structured docs for multi-application portfolio - Added Stock Market Professional documentation: - Architecture & system design - Data monitoring module - Technical analysis engine - Signal generation with constraints (max 3/day, 30min hold) - Added platform architecture overview - Added getting started guide - Added Gitea Actions CI/CD pipeline (build + artifact)
1.6 KiB
1.6 KiB
sidebar_position
| sidebar_position |
|---|
| 1 |
Getting Started
Prerequisites
- Node.js 18+
- pnpm (
npm install -g pnpm) - Git access to gitea.lego-cloud.eu
Development
Clone the repository
git clone ssh://git@gitea.lego-cloud.eu:30009/skic-v1-playground/documentation.git
cd documentation
Install dependencies
pnpm install
Start development server
pnpm start
The site will be available at http://localhost:3000.
Build for production
pnpm build
Serve production build locally
pnpm serve
Adding Documentation
New Application
- Create a directory under
docs/applications/your-app-name/ - Add an
index.mdwith frontmatter - Create subdirectories for each module
- Update
sidebars.tsto include the new section
New Guide
- Create a markdown file under
docs/guides/ - Add frontmatter with
sidebar_position - Update
sidebars.tsif needed
Project Structure
documentation/
├── docs/ # Documentation content
│ ├── intro/ # Welcome & overview
│ ├── applications/ # Per-application docs
│ │ └── stock-market-professional/
│ ├── architecture/ # Platform-wide architecture
│ └── guides/ # How-to guides
├── blog/ # Changelog / updates
├── src/ # Custom components & CSS
├── static/ # Static assets
├── docusaurus.config.ts # Site configuration
├── sidebars.ts # Sidebar structure
└── package.json # Dependencies