Handbook

forge-lenses — reference handbook (internal)

This is the internal maintainer handbook for the lenses package: architecture, APIs, ADRs, wizard internals, and repository workflow. It is built into lenses-docs/ and served at /docs/ when you run Lenses locally.

Public user guides (canonical URLs)

End-user documentation (how to run Lenses, use Forge Studio, and work with the Blueprints Wizard) is published only on blueprints.forgesdlc.com, not as a mirror of this index.html tree:

Do not link the public site to /lenses/handbook/ — that path is a legacy redirect to the hub. Maintainer-only pages below are for local lenses-docs/ or raw files on GitHub.

Local lenses-docs build (maintainers)

The full doc set (internal + docs/handbook-public/ + lenses/website/) is generated for local preview:

python3 generator/build-lenses-docs.py

Output: lenses-docs/. See _load_pages() in the generator for ordering.

Optional — reference page preview PNGs on this home: install html2image and Chromium or Google Chrome, then:

python3 generator/build-lenses-docs.py --previews

or set LENSES_BUILD_DOC_PREVIEWS=1. PNGs are written under lenses-docs/previews/.

Tutorial pipeline (setup, submodules, publishing, extensions, Studio reference architecture) lives in lenses/fa-tutorial-md/, built with forge-autodoc into lenses/tutorials/ and synced to repo-root tutorial/ for the dashboard Tutorial link:

pip install markdown PyYAML
./build-fa-tutorials.sh

Open /local-site/<repo>/tutorial/index.html on the lenses server after building.

Forge Studio (Lenses Studio)

React SPA at /studio/ on the local Python server; shares /api/… with Classic Lenses. Build from lenses-enterprise/; architecture and Kitchen Sink reuse: see the forge-lenses README (Lenses Studio section).

Blueprints Wizard (experimental)

Guided methodology-aligned flow in Forge Studio only (/studio/blueprints/wizard/…). Does not edit the blueprints git submodule.

Published end-user guides: Wizard overview (source: docs/handbook-public/).

Maintainer / operator (local lenses-docs or GitHub):

Reference (Python package)

Internal pages from docs/ and lenses/website/ (see generator for full list):