| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
| Name | Name | Last commit date | ||
|---|---|---|---|---|
Published API reference for the QTSurfer trading engine: the types a strategy author or an embedding application actually uses — strategy bases, the market-data model, the indicator catalogue, backtesting fee/slippage/fill models — not everything that happens to be public in the jars.
Live site: https://qtsurfer.github.io/qtsurfer-engine-java-docs/
This repository holds the built static site at its root, published via GitHub Pages (source: main, /). The engine's own repository documents how the surface is derived and enforced (docs/public-api/README.md there) and a CI job there rebuilds and pushes here. README.md and LICENSE are the only files not overwritten on rebuild; everything else — including versions.json — is generated. Do not hand-edit any of it.
main always holds exactly one live snapshot: the most recently published engine version. It is not per-version browsable — publishing overwrites it.
Every publish is tagged vX.Y.Z after the engine version it was built from. The tag is not immutable: a docs-only fix against an already-released engine version (a typo in docs/public-api/overview.html, a scope correction like this repository's own history) republishes under the same tag, and the tag is force-moved to the new commit. Diff two tags to see what the public API surface changed between engine versions (git diff v0.99.65 v0.99.70, or GitHub's compare view) — that comparison is always against whatever a tag currently points at, not a fixed historical artifact.
versions.json is derived from the tag list on every publish, so it cannot drift from what git tag actually reports:
{
"latest": "v0.99.70",
"versions": ["v0.99.70", "v0.99.65"]
}versions is newest first. It is metadata for a version selector (e.g. in qts-web) to know which engine versions have published docs and which is current — not an index of separately browsable sites. Following an old version today means the git tag, not a live rendered page: https://github.com/QTSurfer/qtsurfer-engine-java-docs/tree/v0.99.65.
| Back | FazBrowse Home | New Git URL |