Skip to content

Documentation provenance and licensing

Lockwell's public documentation is maintained beside the implementation and executable tests in the RusticStack/lockwell repository. Source and tests are authoritative when a page, generated index, or older deployment disagrees with them. A successful pull-request preview is evidence for that commit only; production may remain on an earlier commit until the change merges and deploys.

Content license

The documentation and examples are covered by the repository's PolyForm Noncommercial 1.0.0 license. Commercial use, including TangibleShift integration, requires a written grant from the rights holder. Third-party names, trademarks, linked specifications, and dependencies retain their respective rights. See the repository's third-party license inventory.

Code samples on this site explain the corresponding Lockwell SDK or protocol contract. They do not change the license, publish a package, grant production approval, or expand an API beyond the tested source.

Canonical and fetchable representations

Every documentation page has one canonical HTML URL and a same-path .md representation. The HTML is statically pre-rendered with its primary heading and article content, so JavaScript is not required to read it. These discovery artifacts are stable entry points:

Generated native/admin OpenAPI and protocol indexes are linked from the documentation index. Their source commit must match the site preview or deployment being evaluated.

Generation and verification

The VitePress build copies committed machine-readable contracts, generates HTML, sitemap, raw Markdown, and LLM corpora, then validates links, canonical URLs, descriptions, semantic headings, deterministic unique anchors, JSON-LD, and discovery coverage. A separate fetch smoke sends browser, command-line, search-crawler, and AI-crawler user agents to the same routes and requires equivalent public content; no crawler receives a privileged or weakened-security path.

Reporting drift

Report a documentation mismatch with the page URL, source commit, exported symbol or operation, and the executable test that disagrees. Never include access keys, bearer tokens, customer encryption keys, signed URL query strings, object payloads, or private tenant metadata in an issue.

Source-available under PolyForm Noncommercial 1.0.0; commercial use requires a written grant. License