Documentation provenance and licensing

Lockwell's public documentation is maintained by RusticStack beside the implementation and executable tests it documents. Both repositories are private during early access; contract-pinned source documents are vendored under upstream/ and checked against the core checkout in CI. 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.

LicenseCopy Anchor Link

Lockwell is proprietary, closed-source software during early access. It is made by RusticStack, a software company in Portugal. Using Lockwell requires an early-access licence from RusticStack: write to hello@rusticstack.com. The source code is planned for release under the MIT License; this page will change when that happens. Third-party names, trademarks, linked specifications, and dependencies retain their respective rights.

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 representationsCopy Anchor Link

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:

• /documentation-index.json: formats, indexes, source authority, and license metadata.
• /sdk-capabilities.json: machine-readable shipping SDK capability index.
• /llms.txt: concise page catalog for agents.
• /llms-full.txt: combined Markdown corpus.
• /sitemap.xml: canonical crawl inventory.
• /robots.txt: crawler policy and discovery links.

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 verificationCopy Anchor Link

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 driftCopy Anchor Link

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.