Skip to content

Add Console Agent documentation#1715

Open
jborlase-snowplow wants to merge 6 commits intomainfrom
docs/console-agent
Open

Add Console Agent documentation#1715
jborlase-snowplow wants to merge 6 commits intomainfrom
docs/console-agent

Conversation

@jborlase-snowplow
Copy link
Copy Markdown
Contributor

Summary

  • Adds a new documentation page for the Console Agent under the "Working with AI" section (/docs/llms-support/console-agent/)
  • Covers what the Console Agent is, how permissions work, and its capabilities (tracking design, pipeline management, troubleshooting, data quality, Signals, etc.)
  • Updates the "Working with AI" index page with a reference to the new Console Agent page

Test plan

  • Verify the page renders correctly with yarn start
  • Confirm sidebar navigation shows "Console Agent" under "Working with AI"
  • Check all internal links resolve correctly

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 10, 2026

Deploy Preview for snowplow-docs ready!

Name Link
🔨 Latest commit f4a2512
🔍 Latest deploy log https://app.netlify.com/projects/snowplow-docs/deploys/69e4ef498e8b4e00080f0654
😎 Deploy Preview https://deploy-preview-1715--snowplow-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 22 (🟢 up 1 from production)
Accessibility: 93 (no change from production)
Best Practices: 92 (no change from production)
SEO: 95 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@claude
Copy link
Copy Markdown

claude Bot commented Apr 10, 2026

Style review

A few issues to address based on the style guide:

Terminology

"entity contexts" → "entities" (line 33)
The style guide says: use "entity", never "context". Change:

- Create and manage [event specifications](...) with entity contexts

to:

- Create and manage [event specifications](...) with entities

"collector endpoints" and "collector configuration" → "Collector endpoints" / "Collector configuration" (lines 50, 52)
The style guide specifies: "Collector: Capitalized, with 'the'." Both occurrences need the capital C.

"mini" → "Mini" (line 54)
Snowplow Mini is a product name, same as Micro. Change:

- View mini and Micro development instances

to:

- View Mini and Micro development instances

Console article (line 14)

The style guide states: "Console: Capitalized, no article." Change:

The Console Agent runs as a chat interface inside the Console.

to:

The Console Agent runs as a chat interface inside Console.

H3 headings — prefer imperative voice

Most H3 headings use noun phrases rather than imperative voice. The style guide says: "Prefer imperative voice: 'Initialize the tracker' not 'Tracker initialization'."

Suggested revisions:

Current Suggested
Tracking design Design your tracking
Implementation guidance Implement your trackers
Pipeline management Manage pipelines
Troubleshooting Troubleshoot pipeline issues
Data quality Manage data quality
Console operations Manage console tasks

@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented Apr 10, 2026

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
documentation f4a2512 Commit Preview URL

Branch Preview URL
Apr 19 2026, 03:09 PM

Comment thread docs/llms-support/index.md Outdated

## Console Agent

The [Console Agent](/docs/llms-support/console-agent/index.md) is an AI assistant built into Snowplow BDP Console. It lets you manage your tracking implementation, monitor pipelines, troubleshoot issues, and configure Signals through natural language conversation, using your existing Console permissions.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
The [Console Agent](/docs/llms-support/console-agent/index.md) is an AI assistant built into Snowplow BDP Console. It lets you manage your tracking implementation, monitor pipelines, troubleshoot issues, and configure Signals through natural language conversation, using your existing Console permissions.
The [Console Agent](/docs/llms-support/console-agent/index.md) is an AI assistant built into [Snowplow Console](https://console.snowplowanalytics.com). It lets you manage your tracking implementation, monitor pipelines, troubleshoot issues, and configure Signals through natural language conversation, using your existing Console permissions.

😱

- Navigate directly to relevant Console pages from the chat
- Search and browse the Snowplow documentation

### Signals
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

add a section about docs questions

@mscwilson Miranda Wilson (mscwilson) added the do not merge Flag to denote a Issue or PR which should not yet be merged (usually pending a release) label Apr 16, 2026
jborlase-snowplow and others added 5 commits April 17, 2026 12:36
Update docs to use the Snowplow Assistant name, flag the feature as
Private Preview, and clarify data privacy: no PII access, but message
content and retrieved configuration are processed by a third-party LLM.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Wrap the badge in snowplow-badge-container so it left-aligns with the
CSS flex rule instead of rendering as a centered block image. Also add
a short section explaining the assistant can be disabled per org.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Replace the account-team instruction with the actual self-serve path:
organizations enable or disable the assistant from the Settings section
of the Snowplow Console.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Replace the shields.io image with the AvailabilityBadges component used
on the Identities page, indicating availability on Cloud and Private
Managed Cloud. The Private Preview status remains in the admonition
below.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla:yes do not merge Flag to denote a Issue or PR which should not yet be merged (usually pending a release)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants