Align Mintlify docs with control-plane implementation (v0.3.0 audit)#1
Merged
Conversation
Fix deployment install paths, expand API/config reference for v0.3.0 surfaces, and document multi-worker routing and store-backend semantics verified against enoch-agentic-research-system. Co-authored-by: Cursor <cursoragent@cursor.com>
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: ca3026e013
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Align the example config with config.example.json, correct draft-next and rewrite-draft HTTP behavior, and satisfy docs validation for runtime topology links. Co-authored-by: Cursor <cursoragent@cursor.com>
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.
Summary
/opt/enoch-control-plane,/etc/enoch-control-plane) instead of stale/opt/enoch-agentic-research-systemand/etc/enochpaths./control/papers/draft-next, v1 automation/research endpoints, worker callback docs, publication-automation aliases, and corrected/control/healthresponse (store_backend, Postgres adapter semantics).worker_targets,workload_machine_targets), queue pump flags, store backend settings, and full workload class list (cpu_only,gpu_required,unknown).publish_readydefinition with the system repo runtime snapshot.Verified against
alias8818/enoch-agentic-research-systemat sibling path../enoch-agentic-research-system(VERSION 0.3.0,config.example.json, router endpoints, install scripts).npx mint broken-linkspasses.Test plan
npx mint broken-links— no broken linksscripts/install-control-plane.shdefaultsenoch_control_plane/control_plane/router.pyenoch_control_plane/config.pyandconfig.example.jsonMade with Cursor
Note
Low Risk
Low risk: documentation-only updates, but they touch operational guidance (install paths, config fields, and endpoint contracts) where mistakes could mislead deployments.
Overview
Updates Mintlify docs to match the v0.3.0 control-plane behavior and defaults, including corrected install/config paths and expanded configuration guidance for multi-worker routing, queue pump flags, store backends, and the full workload-class set.
Extends the API reference with additional v1 read/automation endpoints,
POST /control/papers/draft-next,POST /control/api/worker-callback, clarifiedGET /control/healthresponse fields, and notes on publication-automation route aliases and evidence-sync error behavior.Adds 0.3.0 release notes and tightens runtime-snapshot terminology (e.g.,
publish_ready).Reviewed by Cursor Bugbot for commit b2cb57d. Bugbot is set up for automated code reviews on this repo. Configure here.