Skip to content

Documentation Update: 0.6.17#313

Open
sg-doc-holiday[bot] wants to merge 7 commits intomainfrom
sandgarden-doc-2026-02-04-UFmlX31u9R
Open

Documentation Update: 0.6.17#313
sg-doc-holiday[bot] wants to merge 7 commits intomainfrom
sandgarden-doc-2026-02-04-UFmlX31u9R

Conversation

@sg-doc-holiday
Copy link
Contributor

@sg-doc-holiday sg-doc-holiday bot commented Feb 4, 2026

AI Assistance documentation

  • Updates the 'AI Assistance' overview page to replace escaped MDX NarrowImage tags with proper JSX components to ensure correct rendering.
  • Adds detailed explanations on enabling AI assistance, including supported large language models and how to connect them.
  • Documents multiple ways to use AI assistance in OpenOps such as AI assistant chat, AI Step action, Generate with AI commands for CLI and SQL, and generating JavaScript code steps.
  • Enhances clarity on AI assistant chat capabilities, including example questions and integration with MCP servers for answering cost and usage queries.
  • Provides step-by-step guidance on incorporating AI prompts into workflows and generating code snippets using AI within the workflow editor.
  • Fixes remaining escaped NarrowImage tags in the AI Step action section to ensure all screenshots render correctly in the documentation site.
  • Corrects additional escaped NarrowImage tags for the 'Generate with AI' and AI chat window screenshots to ensure proper image rendering.
  • Adds new concise guidance on selecting per-chat language models and details how tool output including errors can appear in AI assistant replies.
  • Fixes remaining escaped NarrowImage tags in multiple sections to ensure proper rendering of screenshots of AI assistant features.
  • Adjusts heading levels for consistency with style guide to maintain documentation structure.

User Management documentation

  • Adds a password requirements section specifying the current validation rules including length and allowed special characters.
  • Enhances API call examples for creating user accounts by adding language tags to HTTP request code blocks per style guide.

This covers 6 commits.

Interaction Instructions

This PR was generated by Doc Holiday and is ready to be iterated on.

Leave comments on this pull request in plain English to guide Doc Holiday's next steps.
You might ask to:

  • Update or rewrite documentation
  • Create or update release notes
  • Remove sections or files
  • Merge this PR with another Doc Holiday PR

Examples:

  • @doc.holiday update these docs to follow my style guide: https://link.to/style-guide
  • @doc.holiday write new documentation about quantum compute and how its steam generates a 429
  • @doc.holiday combine this PR with #404
  • @doc.holiday delete this file: release-notes/file.md

This was opened from: https://github.com/openops-cloud/openops/releases/tag/untagged-9bc549af035e45b92ca0

The publication for this is: Documentation

Replace the escaped MDX NarrowImage tag with a normal JSX self-closing component so the page renders correctly in the documentation site.
Fix the remaining escaped NarrowImage tag so the AI Step screenshot renders correctly in MDX.
Fix the escaped NarrowImage tag for the Generate with AI screenshot so it renders correctly.
Fix the escaped NarrowImage tag for the AI chat window screenshot so it renders correctly.
Insert concise guidance on per-chat model selection and how tool output (including errors) can appear in AI assistant replies, aligning with AI chat/tool output changes while keeping existing structure.
Add a password requirements section reflecting current validation rules (8-64 characters and allowed special characters including square brackets), and add language tags to HTTP request examples per style guide.
Demote the added subsection heading to H3 to comply with the style guide (avoid H4 outside long walkthrough guides).
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.

0 participants