Skip to content

docs: add bun install + markdown docs access (#385, #386)#529

Merged
khaliqgant merged 9 commits intomainfrom
fix/385-386-doc-updates
Mar 10, 2026
Merged

docs: add bun install + markdown docs access (#385, #386)#529
khaliqgant merged 9 commits intomainfrom
fix/385-386-doc-updates

Conversation

@khaliqgant
Copy link
Copy Markdown
Member

@khaliqgant khaliqgant commented Mar 10, 2026

Summary

Closes #385
Closes #386

Test plan

  • Verify README renders correctly on GitHub
  • Verify curl command returns raw markdown

🤖 Generated with Claude Code


Open with Devin

- Added `bun add @agent-relay/sdk` alongside npm install (#385)
- Added plain-text/markdown docs access note and links (#386)

Closes #385
Closes #386

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot left a comment

Choose a reason for hiding this comment

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

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no potential bugs to report.

View in Devin Review to see 1 additional finding.

Open in Devin Review

devin-ai-integration[bot]

This comment was marked as resolved.

devin-ai-integration[bot]

This comment was marked as resolved.

Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot left a comment

Choose a reason for hiding this comment

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

Devin Review found 1 new potential issue.

🐛 1 issue in files not directly in the diff

🐛 Version regex fails to strip openclaw- prefix from GitHub release tags, causing broken download URLs (packages/sdk/src/client.ts:746-747)

The new regex /"tag_name"\s*:\s*"v?([^"]+)"/ only strips an optional leading v from the tag name. The old code explicitly handled openclaw-v* prefixed tags (e.g., openclaw-v3.1.19) by chaining .replace(/^openclaw-/, '').replace(/^v/, ''). This repo has both v* and openclaw-v* tags (see git tag --list). If GitHub's /releases/latest returns an openclaw-v* tagged release, the capture group will contain openclaw-v3.1.19 (since v? doesn't match o in openclaw). This version string is then used at packages/sdk/src/client.ts:775 to build a download URL like https://github.com/.../releases/download/vopenclaw-v3.1.19/..., which is a non-existent URL, causing the broker binary auto-install to fail.

View 10 additional findings in Devin Review.

Open in Devin Review

Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot left a comment

Choose a reason for hiding this comment

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

Devin Review found 1 new potential issue.

🐛 1 issue in files not directly in the diff

🐛 Version regex fails to strip openclaw- prefix from GitHub release tags, causing broken download URLs (packages/sdk/src/client.ts:746-747)

The new regex /"tag_name"\s*:\s*"v?([^"]+)"/ only strips an optional leading v from the tag name. The old code explicitly handled openclaw-v* prefixed tags (e.g., openclaw-v3.1.19) by chaining .replace(/^openclaw-/, '').replace(/^v/, ''). This repo has both v* and openclaw-v* tags (see git tag --list). If GitHub's /releases/latest returns an openclaw-v* tagged release, the capture group will contain openclaw-v3.1.19 (since v? doesn't match o in openclaw). This version string is then used at packages/sdk/src/client.ts:775 to build a download URL like https://github.com/.../releases/download/vopenclaw-v3.1.19/..., which is a non-existent URL, causing the broker binary auto-install to fail.

View 13 additional findings in Devin Review.

Open in Devin Review

@khaliqgant khaliqgant merged commit ed19bd0 into main Mar 10, 2026
30 of 31 checks passed
@khaliqgant khaliqgant deleted the fix/385-386-doc-updates branch March 10, 2026 15:24
khaliqgant added a commit that referenced this pull request Mar 25, 2026
* docs: add bun install instructions and plain-text docs note

- Added `bun add @agent-relay/sdk` alongside npm install (#385)
- Added plain-text/markdown docs access note and links (#386)

Closes #385
Closes #386

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* fix: remove misleading plain-text docs reference

* docs: add plain markdown docs for LLM/CLI access (#386)

* fix: add missing icon to Markdown Docs anchor in mint.json

* fix: correct requestTimeoutMs (10000) and shutdownTimeoutMs (3000) defaults in docs

* docs: add OpenClaw skill section to openclaw reference docs

* docs: slim openclaw reference to overview + skill link

* chore: add docs-sync rule to keep mdx and markdown mirrors in sync

* docs: add LLM/machine-readable docs section linking to markdown mirror

---------

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

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

does docs.agent-relay.com have a markdown only version yet? npm only in the readme? in 2026?

1 participant