Part of Trax: business logic you can call, schedule, or serve as an API, with every run recorded in your Postgres. Docs · Getting started · All repos
Trax.Docs holds the documentation for Trax, published at traxsharp.net/docs, and the decision records for the rules that span more than one Trax repo.
| Path | What it holds |
|---|---|
*.md and the section directories (core/, effect/, mediator/, scheduler/, statemachine/, sdk-reference/, reference/, ...) |
The pages published at traxsharp.net/docs. A file at effect/metadata.md is served at /docs/effect/metadata. |
adr/ |
Architecture decision records that bind more than one repo, indexed in adr/README.md. Not published to the site. |
tools/Trax.Adr.Guard |
The checker for ADR frontmatter, index tables and guard census. It runs on this corpus in CI and is shipped to the code repos as the adr-guard composite action in .github/actions/adr-guard. |
tests/Trax.Docs.Tests |
Lint for the pages: internal links resolve, no em dashes, no Jekyll syntax, SDK reference blocks are well formed. |
A push to main that touches anything outside adr/, .claude/, tools/, tests/ and .github/ triggers a deploy of Trax.Website,
which renders these files.
The site is built by Trax.Website, which reads the docs from a sibling Trax.Docs directory when it finds one:
git clone https://github.com/TraxSharp/Trax.Docs.git
git clone https://github.com/TraxSharp/Trax.Website.git
cd Trax.Website
npm ci
npm run devnpm run dev runs scripts/sync-docs.sh, which copies the Markdown from ../Trax.Docs (your working copy, whatever
branch it is on) into the site before starting it, so restart it to pick up an edit. Without a sibling checkout the script
clones main from GitHub instead.
dotnet testPull requests run the same tests, a CSharpier check and the ADR guard.
Read reference/contributing-docs
before writing a page. It sets the voice, the link format (/docs/<path>), and the rule that a code change and its docs
change ship together. Report vulnerabilities privately as described in
SECURITY.md.
MIT. There is no commercial edition, and there will not be one.
Trax is an independent open-source project and is not affiliated with the Utah Transit Authority, Trax Retail, or any other organization using the Trax name.