Enhance chatbot and pipeline definitions & pipelines page#370
Conversation
…rom chatbot concept. Started improving pipelines page Co-authored-by: Copilot <copilot@github.com>
|
Nice clarity improvements overall. A few non-inline items worth a look: Broken anchor link (caused by this PR) — Removed "Pipelines are the future" admonition — the callout warned readers that older bot-building approaches are being phased out. Worth confirming with the team that the migration is fully complete before dropping it; otherwise users finding the docs mid-transition lose that signal. Chatbot definition in |
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
…Simplified concept terms.
There was a problem hiding this comment.
Pull request overview
Improves conceptual documentation around Open Chat Studio chatbots and pipelines by reframing pipelines as a visual, modular workflow composed of nodes, and by updating related concept pages/links to align with the new structure.
Changes:
- Rewrote the Pipelines concept page to introduce “Pipeline” and “Node” more clearly and to describe the Plan/Execute/Update execution model (including parallelism).
- Added/updated concept definitions for “Chatbot”, “Pipeline”, and introduced “Node” in the concepts index.
- Updated the Parallel Pipelines page to link to the new “How a Pipeline Runs” section anchor.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/concepts/pipelines/parallel.md | Updates cross-link to the renamed execution-model section anchor. |
| docs/concepts/pipelines/index.md | Major rewrite: new pipeline/node definitions, examples, node type overview, and updated execution model section. |
| docs/concepts/index.md | Updates glossary definitions and adds a “Node” entry linking to node docs. |
| docs/concepts/chatbots/index.md | Refines chatbot definition in OCS context and replaces duplicated pipeline explanation with curated links. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Summary Good improvements overall — the definitions are clearer, the execution model description is more accurate, and the anchor update in Issue 1 — Broken admonition indentation ( The body of the Fix: Issue 2 — Missing grid cards wrapper ( The Fix — wrap the list: <div class="grid cards" markdown>
- :material-clock-fast:{ .lg .middle } [__Quickstart Guide__](../../tutorials/first_chatbot.md)
- :material-chat-question:{ .lg .middle } [__What is a Pipeline?__](../pipelines/index.md#what-is-a-pipeline)
- :material-whatsapp:{ .lg .middle } [__Deploying your bot__](../../how-to/deploy_to_different_channels.md)
</div>Issue 3 — Inconsistent bullet indentation ( Bullets in the "Node Types for Complex Pipelines" section each have a leading space ( Issue 4 — Unexpanded abbreviation ( "OCS" is introduced on line 67 with parenthetical expansion ("Open Chat Studio (OCS)"), but the page's first use of the name (line 5) spells it out in full without introducing the abbreviation. Either expand "OCS" everywhere on this page, or move the |
Updates pages to clarify explanations around chatbots, pipelines, and nodes. The changes focus on making the concept pages more accessible and emphasizing the visual workflow and modularity of pipelines.
These changes make the documentation more beginner-friendly and better explain the modular, visual, and parallel nature of chatbot pipelines in Open Chat Studio.
Key documentation improvements:
Clarification of chatbot and pipeline concepts:
Introduction and definition of nodes: