docs(forest-runtime): embedded setup prerequisites & schema isolation - #19
Merged
Conversation
… + framing From customer install feedback: document the workflow-executor peer dep (exact-pinned) and TypeScript 5.5+ prerequisites for the embedded mode, warn that a schema-less table surfaces as a collection, and frame the page as a one-time addition rather than a migration. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
![macroscopeapp[bot]](https://avatars.githubusercontent.com/in/900172?s=60&v=4){kind=small}
…ance Macroscope review: the executor requires Node >= 22.12.0 (was missing), and the schema/ai/encryptionKey/tuning options need an agent newer than 1.84.0 (1.84.0 pins executor 1.12.0; schema landed in executor 1.19.0) — recommend a recent agent instead of the misleading exact floor. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
… in 'forest'
Double-check against the code: resolveSchema() falls back to DEFAULT_SCHEMA
('forest'), so an unset schema does NOT land the table in public and it never
surfaces as a collection. The previous warning was wrong and contradicted the
Tuning table's documented 'forest' default. Also soften the zod/TS wording to
match zod's own statement (tested against TS 5.5+).
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…viour Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up to the Forest Runtime page (already on
main), from real customer install feedback (Roundtable / internal).Fixes
@forestadmin/workflow-executor(optional peer dep the agent loads dynamically at the exact pinned version;tscstays silent when missing butagent.start()throws) and TypeScript 5.5+ (the bundled zod 4 can't be parsed by TS 4.x;skipLibCheckdoesn't help).schema, the executor'sworkflow_step_executionstable lands inpublicand shows up as a collection in the panel; the embedded example now passesschema: 'forest_workflows'.Scope: only
forest-runtime.mdx.🤖 Generated with Claude Code
Note
Update Forest Runtime embedded setup docs with prerequisites and schema isolation notes
@forestadmin/agent>1.84.0, Node.js >=22.12.0,@forestadmin/workflow-executorat the exact agent-pinned version, and TypeScript 5.5+ (required by zod 4 typings)forestPostgres schema by default, configurable via theschemaoption, and that its tables do not appear in collectionsdatabaseandDATABASE_SCHEMAoption descriptions to reflect theforestschema default and its isolation frompublicMacroscope summarized 6b41d50.