Skip to content

Enhance chatbot and pipeline definitions & pipelines page#370

Merged
snopoke merged 6 commits into
mainfrom
pipeline-pages
May 13, 2026
Merged

Enhance chatbot and pipeline definitions & pipelines page#370
snopoke merged 6 commits into
mainfrom
pipeline-pages

Conversation

@lisa-tarbo
Copy link
Copy Markdown
Collaborator

@lisa-tarbo lisa-tarbo commented May 8, 2026

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:

  • Updated the definition of a chatbot to emphasize its role as an AI conversational agent, replacing the older, less clear description.
  • Revised pipelines to highlight their visual workflow nature, modularity, and the use of nodes, replacing the previous flowchart analogy and removing redundant or outdated sections.
  • Also removed "Pipelines are the future" as this seems outdated.

Introduction and definition of nodes:

  • Added a clear definition for "Node" as a single processing step within a chatbot's pipeline workflow in the concepts index.

lisa-tarbo and others added 2 commits May 3, 2026 19:02
…rom chatbot concept. Started improving pipelines page

Co-authored-by: Copilot <copilot@github.com>
Comment thread docs/concepts/pipelines/index.md Outdated
Comment thread docs/concepts/pipelines/index.md Outdated
Comment thread docs/concepts/chatbots/index.md Outdated
@claude
Copy link
Copy Markdown
Contributor

claude Bot commented May 8, 2026

Nice clarity improvements overall. A few non-inline items worth a look:

Broken anchor link (caused by this PR)docs/concepts/pipelines/parallel.md:74 links to index.md#pipeline-execution, but this PR renames that heading to "How a Pipeline Runs", which changes the slug to #how-a-pipeline-runs. The link in parallel.md should be updated in this PR so it doesn't 404.

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 docs/concepts/index.md — the new one-liner ("AI-powered conversational agent configured in Open Chat Studio to interact with users across one or more channels") drops two useful pieces from the old version: (1) that a chatbot aggregates sessions, data, actions, and settings — which is what distinguishes the OCS concept from the generic term — and (2) the historical "Experiment" name, useful for users coming from older versions or older URLs. Consider whether either is worth retaining.

@lisa-tarbo lisa-tarbo changed the title Enhance chatbot and pipeline definitions; update pipelines page Enhance chatbot and pipeline definitions & pipelines page May 9, 2026
@lisa-tarbo lisa-tarbo marked this pull request as ready for review May 9, 2026 15:04
Copilot AI review requested due to automatic review settings May 9, 2026 15:04
@lisa-tarbo lisa-tarbo requested a review from snopoke May 9, 2026 15:04
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

Comment thread docs/concepts/pipelines/index.md
@claude
Copy link
Copy Markdown
Contributor

claude Bot commented May 9, 2026

Summary

Good improvements overall — the definitions are clearer, the execution model description is more accurate, and the anchor update in parallel.md is correct. Four issues need fixing before this renders as intended.

Issue 1 — Broken admonition indentation (docs/concepts/pipelines/index.md, line 83)

The body of the !!! tip block at line 81 uses 2-space indentation. MkDocs Material requires 4 spaces. With 2 spaces the body content will break out of the tip block and render as plain text below it. The second tip block (line 88–90) is correctly indented at 4 spaces for comparison.

Fix:

!!! tip "Running nodes in parallel"

    Because multiple nodes can execute in the same pass, pipelines naturally support parallel processing. See [Parallel Pipelines](./parallel.md) for details.

Issue 2 — Missing grid cards wrapper (docs/concepts/chatbots/index.md, lines 13–15)

The :material-icon:{ .lg .middle } [__Title__](path) pattern is the Material grid cards item syntax (compare docs/index.md lines 30–36), but the content is missing the <div class="grid cards" markdown></div> wrapper. Without it the items render as plain bullet points with inline icons.

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 (docs/concepts/pipelines/index.md, lines 50–62)

Bullets in the "Node Types for Complex Pipelines" section each have a leading space ( - **[LLM Node]...). The bullets earlier in the file (lines 41–44) use the standard - **... format with no leading space. This is inconsistent and may cause linting warnings. Remove the leading space from each of the seven node-type bullets.

Issue 4 — Unexpanded abbreviation (docs/concepts/pipelines/index.md, line 67)

"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 (OCS) expansion to line 5 where the name first appears. The rest of the docs site (e.g. docs/index.md) uses "OCS" freely, so either approach is acceptable — just be consistent within the page.

@snopoke snopoke merged commit 23c1f3e into main May 13, 2026
10 checks passed
@snopoke snopoke deleted the pipeline-pages branch May 13, 2026 07:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants