Skip to content

README.md

Latest commit

 

History

History
23 lines (14 loc) · 832 Bytes

README.md

File metadata and controls

23 lines (14 loc) · 832 Bytes
Raw

Orclient Docs

Documentation website for @ordao/orclient, generated from TypeScript source using TypeDoc.

Deployed at: orclient-docs.frapps.xyz

Build

The build script runs TypeDoc against the orclient source and outputs static HTML to dist/:

npm run build    # generate docs from orclient TypeScript source

Local Preview

npm run start    # serve docs locally on port 5174

How It Works

The build script runs typedoc from the orclient package directory, using libs/orclient/src/orclient.ts as the entry point. The generated HTML is output to this package's dist/ folder. No additional configuration files are needed — TypeDoc reads the TSDoc comments directly from the orclient source.