Skip to content

Fix OpenClaw skill markdown import#1040

Merged
willwashburn merged 1 commit into
mainfrom
codex/fix-openclaw-skill-import
Jun 3, 2026
Merged

Fix OpenClaw skill markdown import#1040
willwashburn merged 1 commit into
mainfrom
codex/fix-openclaw-skill-import

Conversation

@willwashburn
Copy link
Copy Markdown
Member

@willwashburn willwashburn commented Jun 3, 2026

User description

Summary: Move the hosted OpenClaw SKILL.md into web-owned content and update the raw markdown import so the removed packages/openclaw tree is no longer required for the Next build. Verification: npm --prefix web test; npm run build from web.


CodeAnt-AI Description

Move the OpenClaw skill guide into web-owned content and keep it bundled with the app

What Changed

  • The OpenClaw skill markdown now loads from the web app’s own content folder instead of the removed packages path
  • The bundled skill guide still renders the same OpenClaw setup, messaging, and troubleshooting content, so the route continues to serve the full markdown guide
  • The test now reflects that the route serves the OpenClaw skill markdown from the app bundle

Impact

✅ Fewer broken skill imports during web builds
✅ Reliable OpenClaw skill guide delivery
✅ Safer app builds after removing the old package path

💡 Usage Guide

Checking Your Pull Request

Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.

Talking to CodeAnt AI

Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:

@codeant-ai ask: Your question here

This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.

Example

@codeant-ai ask: Can you suggest a safer alternative to storing this secret?

Preserve Org Learnings with CodeAnt

You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:

@codeant-ai: Your feedback here

This helps CodeAnt AI learn and adapt to your team's coding style and standards.

Example

@codeant-ai: Do not flag unused imports.

Retrigger review

Ask CodeAnt AI to review the PR again, by typing:

@codeant-ai: review

Check Your Repository Health

To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.

@willwashburn willwashburn requested a review from khaliqgant as a code owner June 3, 2026 16:40
@codeant-ai
Copy link
Copy Markdown

codeant-ai Bot commented Jun 3, 2026

CodeAnt AI is reviewing your PR.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 3, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

A new OpenClaw/Relaycast skill documentation page is added under web/content/openclaw/SKILL.md with comprehensive setup, message API, and troubleshooting guidance; web/lib/skill-markdown.ts is updated to import from the new documentation location, and the corresponding test description is synchronized.

Changes

OpenClaw Skill Documentation and Routing

Layer / File(s) Summary
Setup and configuration guide
web/content/openclaw/SKILL.md
Package metadata (v3.1.7), OpenClaw introduction, workspace creation/joining instructions, multi-workspace configuration, and expected MCP setup signals with health-check guidance.
Message operations and API usage
web/content/openclaw/SKILL.md
Commands and interpretation for sending messages, reading inbox/channel/DM/thread/search content; dual-auth header requirements for DM reads; observer read-only access; token model, storage locations, and status endpoint caveats.
Troubleshooting and recovery documentation
web/content/openclaw/SKILL.md
Fast-path checks covering setup re-run, failure mode diagnosis, device signature errors, HTTP endpoint validation, and "Not registered" resolution; device pairing explanation with device.json persistence and log-driven requestId approval workflow; auto-recovery guidance and full recovery runbook with validation checklist and diagnostic matrix; execution-policy sandbox lockdown fixes with specific config commands; poll fallback transport configuration including WS→poll state machine, .env knobs, cursor persistence, and usage guidance.
API examples and onboarding recipe
web/content/openclaw/SKILL.md
Optional direct REST API example using curl; minimal onboarding recipe with invite URL, setup commands, and message-sending workflow.
Import routing and test alignment
web/lib/skill-markdown.ts, web/lib/test/skill-markdown.test.ts
Import path updated to load SKILL.md from web/content/openclaw/ instead of packages/openclaw/skill/; test assertion description renamed to "OpenClaw skill markdown" to reflect new source.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Suggested labels

size:XS

Suggested reviewers

  • khaliqgant

Poem

🐰 A skill guide hops into place,
From OpenClaw's feature space!
Setup, troubleshooting, and more—
Documentation to adore.
Routes realigned, tests aligned true,
Ready for all to follow through! 📚

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The description includes a summary section explaining the change, but is missing explicit test plan details and does not follow the provided template structure with checkboxes for test status. Add a Test Plan section with checkboxes indicating whether tests were added/updated and manual testing was completed to align with the repository template.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Fix OpenClaw skill markdown import' clearly and concisely summarizes the main change: relocating the OpenClaw SKILL.md import from packages/openclaw to web-owned content.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/fix-openclaw-skill-import

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.

@gemini-code-assist
Copy link
Copy Markdown

Warning

You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again!

@codeant-ai codeant-ai Bot added the size:XL This PR changes 500-999 lines, ignoring generated files label Jun 3, 2026
@codeant-ai
Copy link
Copy Markdown

codeant-ai Bot commented Jun 3, 2026

CodeAnt AI finished reviewing your PR.

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: a45130e438

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Use a shared workspace key (`rk_live_...`) so all claws join the same workspace:

```bash
npx -y @agent-relay/openclaw@latest setup rk_live_SHARED_WORKSPACE_KEY --name my-claw
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Replace shared-token placeholder on invite pages

When this markdown is served through /openclaw/skill/invite/:token, applyInviteToken inserts a token-specific setup command but only replaces rk_live_YOUR_WORKSPACE_KEY, so this rk_live_SHARED_WORKSPACE_KEY command remains unchanged directly underneath the invite-specific instructions. Users who copy the join-existing-workspace command from an invite page will register with the literal placeholder instead of the provided workspace key unless this placeholder is also replaced or removed for invite renders.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Contributor

@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.

🧹 Nitpick comments (3)
web/content/openclaw/SKILL.md (3)

608-616: ⚡ Quick win

Add language specifier to fenced code block.

For better markdown rendering and syntax highlighting in documentation viewers, specify the language for this code block (use text for diagrams).

📝 Suggested fix
-```
+```text
 WS_ACTIVE  →  (WS failures exceed threshold)  →  POLL_ACTIVE
 POLL_ACTIVE  →  (WS reconnects)  →  RECOVERING_WS
 RECOVERING_WS  →  (WS stable for grace period)  →  WS_ACTIVE
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@web/content/openclaw/SKILL.md` around lines 608 - 616, The fenced code block
containing the state diagram (lines showing WS_ACTIVE → POLL_ACTIVE →
RECOVERING_WS → WS_ACTIVE) is missing a language specifier; update the opening
fence to include "text" (i.e., ```text) so the diagram is rendered with correct
syntax highlighting and markdown rendering in viewers.

406-420: ⚡ Quick win

Add language specifier to fenced code block.

For better markdown rendering and syntax highlighting in documentation viewers, specify the language for this code block.

📝 Suggested fix
-```
+```text
 [openclaw-ws] Pairing rejected — device is not paired with the OpenClaw gateway.
 [openclaw-ws] Approve this device:  openclaw devices approve 3acae370-6897-41aa-85df-fd9f873f8754
 [openclaw-ws] Device ID: 49dacdc54ac11fda...
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@web/content/openclaw/SKILL.md` around lines 406 - 420, The fenced log and
command blocks lack a language specifier; update the first fenced block
containing the gateway logs (the block that starts with "[openclaw-ws] Pairing
rejected — device..." and shows the "openclaw devices approve 3acae370-..."
line) to include a language tag such as "text" for the logs, and update the
subsequent command fenced block that contains "openclaw devices approve
<requestId>" to use "bash" (or "sh") so markdown renderers provide proper syntax
highlighting.

432-440: ⚡ Quick win

Add language specifier to fenced code block.

For better markdown rendering and syntax highlighting in documentation viewers, specify the language for this code block.

📝 Suggested fix
-```
+```text
 [openclaw-ws] Authenticated successfully
 [gateway] OpenClaw gateway WebSocket client ready
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@web/content/openclaw/SKILL.md` around lines 432 - 440, The fenced code block
that shows the OpenClaw logs (lines containing "[openclaw-ws] Authenticated
successfully" and "[gateway] OpenClaw gateway WebSocket client ready") should
include a language specifier for proper rendering; update that fenced block in
SKILL.md to use a language tag (e.g., ```text) immediately after the opening
backticks so the code block becomes ```text and retains the same log content.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@web/content/openclaw/SKILL.md`:
- Around line 608-616: The fenced code block containing the state diagram (lines
showing WS_ACTIVE → POLL_ACTIVE → RECOVERING_WS → WS_ACTIVE) is missing a
language specifier; update the opening fence to include "text" (i.e., ```text)
so the diagram is rendered with correct syntax highlighting and markdown
rendering in viewers.
- Around line 406-420: The fenced log and command blocks lack a language
specifier; update the first fenced block containing the gateway logs (the block
that starts with "[openclaw-ws] Pairing rejected — device..." and shows the
"openclaw devices approve 3acae370-..." line) to include a language tag such as
"text" for the logs, and update the subsequent command fenced block that
contains "openclaw devices approve <requestId>" to use "bash" (or "sh") so
markdown renderers provide proper syntax highlighting.
- Around line 432-440: The fenced code block that shows the OpenClaw logs (lines
containing "[openclaw-ws] Authenticated successfully" and "[gateway] OpenClaw
gateway WebSocket client ready") should include a language specifier for proper
rendering; update that fenced block in SKILL.md to use a language tag (e.g.,
```text) immediately after the opening backticks so the code block becomes
```text and retains the same log content.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 810be142-fd4e-455d-95e8-497a3ff3a05a

📥 Commits

Reviewing files that changed from the base of the PR and between 0a65127 and a45130e.

📒 Files selected for processing (3)
  • web/content/openclaw/SKILL.md
  • web/lib/skill-markdown.ts
  • web/lib/test/skill-markdown.test.ts

Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

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

No issues found across 3 files

Re-trigger cubic

@willwashburn willwashburn merged commit a5ce5aa into main Jun 3, 2026
29 of 30 checks passed
@willwashburn willwashburn deleted the codex/fix-openclaw-skill-import branch June 3, 2026 17:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:XL This PR changes 500-999 lines, ignoring generated files

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant