docs: clarify generateSchemaOnly() writes typings too + the "Only" naming

[Scra3]

What

Follow-up to the generateSchemaOnly() docs (already merged). Clarifies two recurring points of confusion:

1. It writes the typings too. When typingsPath is set in createAgent, a single generateSchemaOnly() call writes both the schema and the TypeScript typings, in one pass. Made explicit that the method takes no arguments and reads the paths from the agent options.
2. The "Only" naming. Only means it only generates the files (no agent start, no call to Forest) — not "the schema only". Points to agent.updateTypesOnFileSystem() for the typings-only case.

Why

The name reads as "schema only", which led to confusion about whether typings are produced. This spells out the actual behavior in the API reference.

Single-file change to reference/agent-api/nodejs.mdx, on top of the current main.

🤖 Generated with Claude Code

Note

Clarify that generateSchemaOnly() also writes typings when typingsPath is set

• Updates nodejs.mdx to clarify that generateSchemaOnly() takes no arguments, reads schemaPath, typingsPath, and typingsMaxDepth from createAgent options, and writes typings in the same pass when typingsPath is configured.
• Adds a note explaining that "Only" means the method generates files without starting the agent or sending the schema, and points to agent.updateTypesOnFileSystem() for regenerating typings alone.
• Updates deploy.mdx to advise that the typings file should be included in CI diff checks when committed, or excluded when not committed, to avoid stale-typings or broken-build issues.

^{Macroscope summarized 44d31ce.}

[mintlify]

Preview deployment for your docs. Learn more about Mintlify Previews.

Project	Status	Preview	Updated (UTC)
forest	🟢 Ready	View Preview	Jul 1, 2026, 6:06 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.