Documentation versions
These docs always track the latest published release. This page explains the versioning policy and where to find documentation and changelogs for earlier versions.
Current version
This site documents StreetJS v1.2.7 — the version is injected at
build time from the published @streetjs/cli
package, so it can never drift from the released package.
The full version-support window, LTS status, and backport policy live in the Support Matrix.
Versioning policy
- Docs track latest. The published site always reflects the newest release on
the
mainbranch. Breaking changes are called out in the Changelog and the relevant guide pages. - Semantic Versioning.
@streetjs/corefollows SemVer 2.0.0. A major bump signals a breaking change; the changelog records the migration path. - Per-release evidence is immutable. Every release tag carries its own reproducible CycloneDX SBOM and npm provenance attestation (see the Trust Center).
Finding docs for an earlier version
Because the docs site tracks latest, earlier-version documentation is retrieved from the corresponding git tag rather than hosted as a separate site:
| Need | Where |
|---|---|
| Changelog for any version | Changelog / CHANGELOG.md |
Docs as they were at version vX.Y.Z |
Browse the repo at that tag: https://github.com/hassanmubiru/StreetJS/tree/vX.Y.Z/docs |
| Migrating between majors | Migration guide |
| Support window / LTS / backports | Support Matrix |
| API surface at a release | The published package on npm for that version |
To read the docs exactly as they shipped with, say, v1.0.25:
1
2
3
4
git clone https://github.com/hassanmubiru/StreetJS
cd StreetJS
git checkout v1.0.25
# docs/ now reflects that release
Roadmap: browsable multi-version docs
A version selector that serves multiple doc trees side by side (in the style of Docusaurus/Nuxt) is tracked as a roadmap item. The current policy — latest docs + tagged historical source + an immutable changelog — covers the common need (finding what changed and reading older docs) without the maintenance cost of duplicating the full site per release. See plans/OUTSTANDING-ACTIONS.md.