Skip to content

Repository files navigation

TradeJS-Docs

Standalone Docusaurus documentation site for the TradeJS framework.

Source of truth for docs.tradejs.dev. Core framework code stays in TradeJS; project composition, deployment, Base, Strategy Kit, and strategy implementations live in their own public repositories.

Public Docs Entry Points

Install

npm install

Run

Build and serve both locales:

npm run dev

Site runs on http://localhost:3001.

Hot Reload

Docusaurus dev server supports one locale per process.

npm run dev:hot:en
npm run dev:hot:ru

Build

yarn checks

yarn checks runs TypeScript validation and builds both locales.

Container Image

Pushes to main publish ghcr.io/tradejs-dev/tradejs-docs:<full-source-sha>. Mutable latest tags are not part of the production contract.

Production Deploy

This repository does not have production SSH access. After an image is published, deploy its full source SHA through the Deploy production component workflow in TradeJS-Deploy with component=docs.

Optional registry bootstrap secrets when org-level GITHUB_TOKEN cannot publish packages:

  • GHCR_USERNAME
  • GHCR_TOKEN

TradeJS-Deploy alone owns Compose, the server credentials, and the exact production release state. GHCR package tradejs-docs must stay public so the production host can pull it without registry login.

Keywords: ai, claude, codex.

About

Public documentation site for docs.tradejs.dev

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages