Skip to content

Update gettingStarted.tsx#611

Closed
aylaju wants to merge 2 commits intomainfrom
mcp-docs
Closed

Update gettingStarted.tsx#611
aylaju wants to merge 2 commits intomainfrom
mcp-docs

Conversation

@aylaju
Copy link
Collaborator

@aylaju aylaju commented Mar 16, 2026

Summary by CodeRabbit

  • New Features

    • Introduced MCP (Model Context Protocol) as a new operating mode alongside bundled and integrated.
    • Mode selector and UI now include an MCP option and show MCP-specific code samples and language formatting.
    • Install/setup instructions now include MCP-specific guidance.
  • Documentation

    • README rewritten to emphasize warehouse-native delivery, AI/MCP capabilities, config-as-code, schema validation, and updated destination/usage messaging.

@vercel
Copy link

vercel bot commented Mar 16, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
demo-tagging Ready Ready Preview, Comment Mar 19, 2026 1:03pm
storybook Ready Ready Preview, Comment Mar 19, 2026 1:03pm
website Ready Ready Preview, Comment Mar 19, 2026 1:03pm

@coderabbitai
Copy link

coderabbitai bot commented Mar 16, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 28b83209-7dbf-47de-b048-af4af942a3da

📥 Commits

Reviewing files that changed from the base of the PR and between cd6da11 and f3205f6.

📒 Files selected for processing (1)
  • README.md
✅ Files skipped from review due to trivial changes (1)
  • README.md

📝 Walkthrough

Walkthrough

The Getting Started component adds an MCP operating mode alongside bundled and integrated, updating UI (mode button, descriptions, code tab, language selection), navigation/doc links, and install text to surface MCP-specific config and docs. README content and positioning were rewritten to emphasize MCP and warehouse-native messaging.

Changes

Cohort / File(s) Summary
Getting Started UI
website/src/components/organisms/gettingStarted.tsx
Added mcp mode to internal state, MCP mode button and active styling, extended conditional logic for mode descriptions, code tab label/content (uses mcpCode / mcp_config.json), and language selection (JSON for bundled/mcp, TS for integrated). Updated navigation and doc links to include mcp-docs and changed install text for MCP server.
Documentation / Marketing
README.md
Rewrote positioning and messaging to emphasize "event collection you own" and "warehouse-native" delivery; added "The problem" section; updated "Why walkerOS?" bullets and "How it works" wording (added validation); added "AI-ready via MCP" section describing MCP interface for AI agents; removed/edited some destination mentions and reformatted demo/resource links.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

  • types #602 — Modifies website/src/components/organisms/gettingStarted.tsx; related changes to mode handling and tagger integration.

Suggested reviewers

  • alexanderkirtzel

Poem

🐰 I hopped into the code today,
Three modes now split the play,
MCP whispers JSON tunes,
Docs and configs hum like moons,
Hooray — new paths for tracking day!

🚥 Pre-merge checks | ✅ 1 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
Title check ❓ Inconclusive The title 'Update gettingStarted.tsx' is vague and generic, using non-descriptive language that fails to convey meaningful information about the changeset. Provide a more specific title that describes the actual change, such as 'Add MCP mode support to Getting Started component' or 'Introduce Model Context Protocol integration to gettingStarted.tsx'.
✅ Passed checks (1 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch mcp-docs
📝 Coding Plan
  • Generate coding plan for human review comments

Warning

Review ran into problems

🔥 Problems

Git: Failed to clone repository. Please run the @coderabbitai full review command to re-trigger a full review. If the issue persists, set path_filters to include or exclude specific files.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Tip

CodeRabbit can generate a title for your PR based on the changes.

Add @coderabbitai placeholder anywhere in the title of your PR and CodeRabbit will replace it with a title based on the changes in the PR. You can change the placeholder by changing the reviews.auto_title_placeholder setting.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@website/src/components/organisms/gettingStarted.tsx`:
- Around line 178-202: The link for MCP mode (the ternary branch that yields
'/docs/apps/mcp/') is pointing to a non-existent docs page and the tagger.action
event names use hyphens rather than the required space-separated format; fix by
either creating the docs/apps/mcp/index.mdx and adding 'apps/mcp' to the apps
category in sidebars.ts so '/docs/apps/mcp/' is valid, or change the branch URL
to an existing docs path if you prefer not to add new docs, and update the
tagger.action calls in this component to use space-separated event names
('bundled docs', 'integrated docs', 'mcp docs') instead of 'bundled-docs',
'integrated-docs', 'mcp-docs' so they conform to the entity action format.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a40fe1d8-f9af-4228-953b-01af49cde443

📥 Commits

Reviewing files that changed from the base of the PR and between c516a9b and cd6da11.

📒 Files selected for processing (1)
  • website/src/components/organisms/gettingStarted.tsx

Comment on lines 178 to +202
to={
mode === 'bundled'
? '/docs/getting-started/modes/bundled/'
: '/docs/getting-started/modes/integrated/'
: mode === 'integrated'
? '/docs/getting-started/modes/integrated/'
: '/docs/apps/mcp/'
}
className="text-lg font-semibold"
style={{ color: 'var(--color-base-content)' }}
{...tagger
.action(
'click',
mode === 'bundled' ? 'bundled-docs' : 'integrated-docs',
mode === 'bundled'
? 'bundled-docs'
: mode === 'integrated'
? 'integrated-docs'
: 'mcp-docs',
)
.get()}
>
{mode === 'bundled'
? 'Install walkerOS CLI'
: 'Install npm packages'}{' '}
: mode === 'integrated'
? 'Install npm packages'
: 'Install MCP server'}{' '}
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Description: Check if MCP docs page exists and if sidebar includes it

echo "=== Checking for MCP docs page ==="
fd -t f -e md -e mdx 'mcp' website/docs/

echo ""
echo "=== Checking sidebars.ts for mcp entry ==="
rg -n 'mcp' website/sidebars.ts || echo "No 'mcp' entry found in sidebars.ts"

echo ""
echo "=== Current apps category in sidebars.ts ==="
rg -A 10 "label: 'Apps'" website/sidebars.ts

Repository: elbwalker/walkerOS

Length of output: 446


🏁 Script executed:

# Search more broadly for MCP references in the codebase
echo "=== Searching all references to 'mcp' in the repo ==="
rg -i 'mcp' --max-count=20

echo ""
echo "=== Checking docs directory structure ==="
ls -la website/docs/apps/

echo ""
echo "=== Checking if there's a top-level mcp reference ==="
find website/docs -type d -name '*mcp*' 2>/dev/null || echo "No directories with 'mcp' in name found"

echo ""
echo "=== Checking the actual component file for context ==="
sed -n '170,210p' website/src/components/organisms/gettingStarted.tsx

Repository: elbwalker/walkerOS

Length of output: 5857


Fix the broken MCP documentation link and correct event naming format.

The component links to /docs/apps/mcp/ when MCP mode is selected, but this documentation page does not exist in website/docs/apps/ and is not registered in sidebars.ts. This will result in a 404 error for users. Additionally, the event names passed to tagger.action() violate the coding guidelines—they use hyphens ('bundled-docs', 'integrated-docs', 'mcp-docs') instead of the required space-separated format ('bundled docs', 'integrated docs', 'mcp docs').

Please:

  1. Create the MCP documentation at docs/apps/mcp/index.mdx with appropriate content, or update the link to point to existing documentation
  2. Add 'apps/mcp' to the apps category items in sidebars.ts if the docs page is created
  3. Fix the event naming to use spaces instead of hyphens to comply with the entity action format guideline
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@website/src/components/organisms/gettingStarted.tsx` around lines 178 - 202,
The link for MCP mode (the ternary branch that yields '/docs/apps/mcp/') is
pointing to a non-existent docs page and the tagger.action event names use
hyphens rather than the required space-separated format; fix by either creating
the docs/apps/mcp/index.mdx and adding 'apps/mcp' to the apps category in
sidebars.ts so '/docs/apps/mcp/' is valid, or change the branch URL to an
existing docs path if you prefer not to add new docs, and update the
tagger.action calls in this component to use space-separated event names
('bundled docs', 'integrated docs', 'mcp docs') instead of 'bundled-docs',
'integrated-docs', 'mcp-docs' so they conform to the entity action format.

@aws-amplify-eu-central-1
Copy link

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-611.d27uka2p9i8zm5.amplifyapp.com

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.

2 participants