build-unity-docs

command
v0.2.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 12, 2026 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Overview

build-unity-docs converts the offline Unity ScriptReference HTML tree into a single JSONL file that ships with the connector. Run once per Unity version, commit the result. Mirrors the C# UnityDocsParser regex set so the Connector can drop its HTML-parsing path entirely.

go run ./tools/build-unity-docs \
    --in  "$UNITY_DOCS_ROOT/Documentation/en" \
    --out AgentConnector/Editor/Data/unity_docs_6000.0.jsonl.gz.bytes \
    --unity-version 6000.0

Output line shape:

{"name":"Rigidbody-mass","title":"Rigidbody.mass","signature":"public float mass;",
 "summary":"The mass of the rigidbody.","manual_url":"Manual/class-Rigidbody.html",
 "scriptreference_url":"ScriptReference/Rigidbody-mass.html","unity_version":"6000.0"}

`name` is the filename without `.html` so the Connector's existing query→candidate-filename mapping doubles as the dict lookup key.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL