Skip to content

Move docs into web/content/docs for reliable Lambda bundling#617

Merged
willwashburn merged 3 commits intomainfrom
feat/move-docs-into-web
Mar 21, 2026
Merged

Move docs into web/content/docs for reliable Lambda bundling#617
willwashburn merged 3 commits intomainfrom
feat/move-docs-into-web

Conversation

@willwashburn
Copy link
Member

@willwashburn willwashburn commented Mar 21, 2026

Summary

  • Copies docs .mdx files into web/content/docs/ (same pattern as web/content/blog/)
  • Updates docs.ts to read from the local content/docs/ directory instead of ../docs/
  • Removes ../docs/**/*.mdx from outputFileTracingIncludes — no longer needed
  • Updates docs-sync rule to reflect three-way sync requirement
  • Removes docs/**/*.mdx from deploy workflow trigger (covered by web/**)

Why

The docs were in the repo root docs/ directory and relied on outputFileTracingIncludes to get bundled into the Lambda. After SST remove + redeploy, the files weren't being included, causing Access Denied on all /docs routes.

Test plan

  • next build passes locally
  • Deploy and verify /docs routes work
  • Verify /docs/quickstart, /docs/reference/sdk all load

🤖 Generated with Claude Code


Open with Devin

The docs .mdx files were in the repo root docs/ directory and relied on
outputFileTracingIncludes to get bundled into the Lambda function. This
was fragile and caused Access Denied errors in production when the files
weren't included. Moving them into web/content/docs/ (same pattern as
blog) ensures they're automatically bundled.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copy link
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 3 additional findings.

Open in Devin Review

- Delete Mintlify config, assets, and MDX source from docs/
- Move plain markdown mirror from docs/markdown/ up to docs/
- web/content/docs/*.mdx is now the single MDX source
- docs/*.md is the plain markdown mirror

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copy link
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 8 new potential issues.

View 6 additional findings in Devin Review.

Open in Devin Review

Comment on lines +95 to +97
<Card title="📄 Markdown Docs on GitHub" icon="file-lines" href="https://github.com/AgentWorkforce/relay/tree/main/docs/markdown">
Plain-text versions of every page — no MDX components, no JavaScript. Designed for `curl`, agents, and language models.
</Card>
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot Mar 21, 2026

Choose a reason for hiding this comment

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

🔴 Stale link to removed docs/markdown directory in introduction.mdx (docs-sync rule violation)

The .md mirror at docs/introduction.md:94 was correctly updated to link to https://github.com/AgentWorkforce/relay/tree/main/docs, but the corresponding MDX source at web/content/docs/introduction.mdx:105 still references the old https://github.com/AgentWorkforce/relay/tree/main/docs/markdown path, which was deleted in this PR. This violates the docs-sync rule (.claude/rules/docs-sync.md, rule 1): "Any change to an .mdx file must be mirrored to the corresponding .md file, and vice versa." The stale URL will render as a broken 404 link on the production docs site.

Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

- Convert <CardGroup>/<Card> to plain markdown lists
- Fix <Note> blockquote continuation lines
- Restore SDK reference sections lost by incorrect --- stripping
- Fix broken docs/markdown link to docs/

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@willwashburn willwashburn merged commit 657e6db into main Mar 21, 2026
32 checks passed
@willwashburn willwashburn deleted the feat/move-docs-into-web branch March 21, 2026 16:28
Copy link
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.

View 7 additional findings in Devin Review.

Open in Devin Review

Comment on lines 5 to 7
# @agent-relay/openclaw

Relaycast bridge for OpenClaw — connects your OpenClaw instances to Relaycast for real-time multi-agent communication across channels, DMs, and threads.
Copy link
Contributor

Choose a reason for hiding this comment

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

🟡 Duplicate H1 headings in openclaw.md

The new content added to docs/reference/openclaw.md introduces a second # (H1) heading. Lines 1 and 5 are both H1: # OpenClaw Bridge and # @agent-relay/openclaw. The MDX source (web/content/docs/reference/openclaw.mdx) has the title "OpenClaw Bridge" in frontmatter and only # @agent-relay/openclaw in the body. The .md mirror should have a single H1 derived from the frontmatter title, not two competing H1 headings.

Suggested change
# @agent-relay/openclaw
Relaycast bridge for OpenClaw — connects your OpenClaw instances to Relaycast for real-time multi-agent communication across channels, DMs, and threads.
# OpenClaw Bridge
Relaycast bridge for OpenClaw -- real-time multi-agent messaging and spawning.
Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

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.

1 participant