Docs

fix: Manage Return of 0 Batch Qty & Qty fix #4

	name: Docs

	permissions:
	contents: read

	on:
	push:
	branches: ["**"]
	pull_request:
	branches: ["**"]

	jobs:
	docs-check:
	name: TypeDoc check
	runs-on: ubuntu-22.04

	steps:
	- name: Checkout
	uses: actions/checkout@v4

	- name: Setup Node
	uses: actions/setup-node@v4
	with:
	node-version: "20"
	cache: "yarn"
	cache-dependency-path: frontend/yarn.lock

	- name: Install frontend dependencies
	working-directory: frontend
	run: yarn install --frozen-lockfile

	- name: Validate TypeDoc entry points
	working-directory: frontend
	# docs:check runs TypeDoc without writing output so CI stays clean.
	# Exit code is non-zero if any entry point has TypeDoc errors.
	run: yarn docs:check

	docs-generate:
	name: Generate & upload API reference
	runs-on: ubuntu-22.04
	# Only run on pushes to develop or main so we don't create an artifact on every PR branch.
	if: github.event_name == 'push' && (github.ref == 'refs/heads/develop' \|\| github.ref == 'refs/heads/main')
	needs: docs-check

	steps:
	- name: Checkout
	uses: actions/checkout@v4

	- name: Setup Node
	uses: actions/setup-node@v4
	with:
	node-version: "20"
	cache: "yarn"
	cache-dependency-path: frontend/yarn.lock

	- name: Install frontend dependencies
	working-directory: frontend
	run: yarn install --frozen-lockfile

	- name: Generate API docs
	working-directory: frontend
	run: yarn docs:generate

	- name: Upload API reference artifact
	uses: actions/upload-artifact@v4
	with:
	name: api-docs
	path: frontend/docs/api/
	retention-days: 30

Navigation Menu