Skip to content

chore: Update agent docs location#600

Merged
michaeljguarino merged 4 commits into
mainfrom
update-agent-docs-location
May 15, 2026
Merged

chore: Update agent docs location#600
michaeljguarino merged 4 commits into
mainfrom
update-agent-docs-location

Conversation

@maciaszczykm
Copy link
Copy Markdown
Member

Plural Flow: docs
Plural Preview: docs

@maciaszczykm maciaszczykm requested a review from a team as a code owner May 15, 2026 08:47
Copy link
Copy Markdown
Contributor

@plural-copilot plural-copilot Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Deploy preview for docs-pr-600 is ready!

Name Details
⚡ Service docs-pr-600 (5 / 5 ready)
☁️ Cluster plural (eks)
:octocat: Commit sha 7111cae
Plural URL https://console.mgmt.plural.sh/cd/clusters/446acdef-8524-425a-a49f-5336a...
🔍 Logs URL https://console.mgmt.plural.sh/cd/clusters/446acdef-8524-425a-a49f-5336a...
🌊 Flow URL https://console.mgmt.plural.sh/flows/08a17af1-8578-449e-9ae1-28ccd97eafc...
Preview Link Preview

You can learn more about preview environments and Plural Flows here

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 15, 2026

Greptile Summary

This PR updates the source URL for auto-generating agent API reference docs, reflecting that the deployment-operator code has been consolidated into the console monorepo under go/deployment-operator/. The synced markdown file also picks up a new disableWebsocket field.

  • Makefile: sync-operator-crd-docs target now fetches from pluralsh/console/master/go/deployment-operator/docs/api.md instead of the standalone pluralsh/deployment-operator repository.
  • agent-api-reference.md: Adds the disableWebsocket boolean field to the AgentDeploymentConfig table with a well-written description explaining its purpose for large-scale edge deployments.

Confidence Score: 5/5

Safe to merge — the change is a straightforward URL redirect to the new monorepo location and a docs content sync.

The only code change is updating a curl URL in the Makefile and the resulting synced markdown. The new URL points to a well-formed path within the console monorepo, consistent with how the sync-console-crd-docs target already fetches from the same repo. The new disableWebsocket field in the markdown is complete and clearly described.

No files require special attention.

Important Files Changed

Filename Overview
Makefile Updates the sync-operator-crd-docs target URL from the standalone deployment-operator repo to its new location inside the console monorepo at go/deployment-operator/docs/api.md.
pages/api-reference/kubernetes/agent-api-reference.md Adds the new disableWebsocket boolean field to the agent config table, synced from the updated upstream source. Description is clear and complete.

Reviews (2): Last reviewed commit: "update docs" | Re-trigger Greptile

Comment thread pages/api-reference/kubernetes/agent-api-reference.md
Comment thread pages/api-reference/kubernetes/agent-api-reference.md
@maciaszczykm
Copy link
Copy Markdown
Member Author

@greptileai

@maciaszczykm maciaszczykm changed the title chore: update agent docs location chore: Update agent docs location May 15, 2026
@michaeljguarino michaeljguarino merged commit ab8d96a into main May 15, 2026
12 of 13 checks passed
@michaeljguarino michaeljguarino deleted the update-agent-docs-location branch May 15, 2026 14:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants