Docs dev sdk draft

[ijonele]

No description provided.

[vercel]

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

Project	Deployment	Actions	Updated (UTC)
warden-help-center	Ready	Preview, Comment	Mar 3, 2026 8:31am

[coderabbitai]

📝 Walkthrough

Walkthrough

This PR restructures the agent development documentation from a "publish-an-agent" framework to a "build-an-agent" framework. It introduces comprehensive build guides (creation, configuration, custom logic, testing, hosting), new developer tools documentation (Warden Code, Warden Studio), and updates navigation across the docs site via configuration changes and URL redirects. Old publish-specific pages are removed and replaced with unified build-first content.

Changes

Cohort / File(s)	Summary
Core Build Agent Documentation build-an-agent/create-a-new-agent.md, build-an-agent/configure-the-agent.md, build-an-agent/implement-custom-logic.md, build-an-agent/test-the-agent-locally.md, build-an-agent/technical-requirements.md	New comprehensive guides covering agent creation workflow, configuration updates, custom logic implementation, local testing with UI/CLI/API interactions, and technical requirements for agent development.
Developer Tools Documentation build-an-agent/developer-tools/_category_.json, build-an-agent/developer-tools/warden-code.md, build-an-agent/developer-tools/warden-studio.md	New developer tools section with Warden Code CLI documentation (installation, commands, project structure, supported models) and Warden Studio overview (features, discoverability, monetization).
Build Agent Structure & Overview build-an-agent/_category_.json, build-an-agent/introduction.md, build-an-agent/warden-agent-capabilities.md, build-an-agent/publish-on-warden.md, build-an-agent/host-your-agent.md, build-an-agent/register-on-erc-8004.md	New foundational pages for build-an-agent section including introduction, agent capabilities matrix, publishing/monetization guidance, hosting instructions, and ERC-8004 registration placeholder.
Navigation Configuration Updates docusaurus.config.ts, sidebars.ts, vercel.json, home.mdx	Updated Docusaurus navbar item (publishAgent → buildAgent), renamed sidebar entry with new directory mapping, added redirects mapping /publish-an-agent/* paths to /build-an-agent/*, and updated homepage card navigation links.
Existing Documentation Link Updates learn/introduction-to-warden.md, learn/glossary.md	Updated internal navigation links from /publish-an-agent/* to /build-an-agent/* paths and corrected Warden Studio glossary reference to developer tools section.
Deprecated Documentation Removal publish-an-agent/introduction.md, publish-an-agent/publish-your-agent.md	Removed outdated publish-focused introduction page and comprehensive publish guide; content superseded by build-an-agent structure.
Text Corrections docs/developer-docs/.spelling, docs/help-center/.spelling, learn/warden-manifesto.md, learn/whitepaper.md, help-center/docusaurus.config.ts	Removed "frontend" from spelling dictionaries, normalized "front-ends" to "frontends" in manifesto and whitepaper, and enabled Algolia insights in help-center config.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~30 minutes

Possibly related PRs

• added details about warden studio #1815: Modifies the same publish-an-agent documentation files (introduction.md, publish-your-agent.md) that are being removed and redirected in this PR.
• Docs community #1772: Updates the same Docusaurus configuration files (docusaurus.config.ts, sidebars.ts) for sidebar navigation restructuring.
• Docs spaceward chiado #943: Removes the "frontend" entry from the same spelling dictionary files (docs/help-center/.spelling).

Suggested reviewers

• jjheywood
• alijnmerchant21

🚥 Pre-merge checks | ✅ 1 | ❌ 2

❌ Failed checks (2 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'Docs dev sdk draft' is vague and generic, using non-descriptive terms that don't clearly convey the primary changes in the changeset.	Consider a more descriptive title that reflects the main documentation updates, such as 'Restructure agent documentation from publish-centric to build-centric flow' or 'Add build-an-agent documentation section with technical guides'.
Description check	❓ Inconclusive	No pull request description was provided by the author, making it impossible to assess relevance to the changeset.	Add a pull request description that explains the purpose of these documentation changes, such as restructuring the agent developer workflow or adding comprehensive build guides.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches

• 📝 Generate docstrings (stacked PR)
• 📝 Generate docstrings (commit on current branch)

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs-dev-sdk-draft

Tip

Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).
Share your feedback on Discord.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 16

🧹 Nitpick comments (1)

docs/developer-docs/docs/build-an-agent/build-an-agent/create-a-new-agent.md (1)

98-100: Clarify API key handling guidance to avoid ambiguity.

The warning should explicitly say not to commit .env and to use deployment secret storage, rather than implying users should always delete local .env values.

As per coding guidelines, "**/*.md: Assess the documentation for misspellings, grammatical errors, missing documentation and correctness".

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/developer-docs/docs/build-an-agent/build-an-agent/create-a-new-agent.md`
around lines 98 - 100, The existing warning in create-a-new-agent.md is
ambiguous about API key handling; update the warning block to explicitly
instruct users not to commit their .env file (do not check `.env` into version
control), to store API keys in deployment secret storage or environment variable
managers for production, and to use a local `.env` only for development—removing
or rotating keys before publishing; reference the warning block in this document
to replace the current text with this clearer guidance.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In
`@docs/developer-docs/docs/build-an-agent/build-an-agent/create-a-new-agent.md`:
- Around line 73-91: Fix three typos in the documentation text: change
"Mulit-turn converstions" to "Multi-turn conversations", change "You Agent's
skills" to "Your Agent's skills", and change "based one of the supported" to
"based on one of the supported" in the create-a-new-agent.md content under the
setup flow/results section.

In
`@docs/developer-docs/docs/build-an-agent/build-an-agent/implement-custom-logic.md`:
- Around line 74-78: The inline example command includes a trailing period that
breaks the URL (`/chat http://localhost:3000.`); update the code block in
implement-custom-logic.md to remove the trailing dot so the command reads `/chat
http://localhost:3000` and move any sentence punctuation outside the fenced code
block to keep the example executable and correct.

In
`@docs/developer-docs/docs/build-an-agent/build-an-agent/test-the-agent-locally.md`:
- Around line 38-42: The sentence "The fastest way to make sure your Agent is
running opening the local host URL:" is ungrammatical and uses "local host"
incorrectly; update the sentence in the markdown (around the line containing the
http://localhost:3000 example) to read something like "The fastest way to make
sure your Agent is running is to open the localhost URL:" using "localhost" as
one word and maintaining the following URL block.
- Line 227: The `/config` link currently points to the wrong anchor
`implement-custom-logic#build-with-ai`; update the link target so `/config`
points to the configuration guide anchor (replace
`implement-custom-logic#build-with-ai` with the correct configuration guide
anchor for configuration instructions) in the same markdown line where `/config`
is referenced to ensure the link directs users to the configuration guide rather
than the build-with-ai section.

In `@docs/developer-docs/docs/build-an-agent/developer-tools/warden-code.md`:
- Around line 238-240: The markdown row for "Create Run, Wait for Output"
incorrectly reuses the stream-output reference URL; update the link target for
the "Create Run, Wait for Output" entry so it points to the correct reference
page for the wait endpoint (the row with link text "Create Run, Wait for Output"
and endpoint `/threads/{thread_id}/runs/wait`) instead of the stream-output URL.
- Line 11: Fix the typographical error in the documentation sentence that
currently reads "athe **A2A protocol**, **x402 payments**, and **ERC-8004
identity**" by changing "athe" to "the"; locate the sentence containing the
phrases "A2A protocol", "x402 payments", and "ERC-8004 identity" in
docs/developer-docs/docs/build-an-agent/developer-tools/warden-code.md and
update the text to "the **A2A protocol**, **x402 payments**, and **ERC-8004
identity**" to comply with the spelling/grammar guidelines.
- Around line 111-115: The table row for the `/register` endpoint has link text
"Register on ERC-8004" but its href incorrectly points to `configure-the-agent`;
update the anchor target associated with that table cell so it points to the
documentation page that actually covers registering on ERC-8004 (e.g., the
correct doc slug such as `register-on-erc-8004` or the exact page used elsewhere
for Agent registration) by editing the link in the table cell that contains
"Register on ERC-8004" to the correct relative path.

In `@docs/developer-docs/docs/build-an-agent/developer-tools/warden-studio.md`:
- Line 7: The link label "Warden" points to the help-docs domain; update the
markdown so the link target matches the product label: either change the URL for
the "**Warden**" link in the "Warden Studio" sentence to the Warden app URL (so
label and destination both refer to the app), or if you intend to link to docs,
rename the link label to "Warden Help" or "Warden docs" to match the help-docs
URL; adjust the link text/target in that markdown line accordingly.

In `@docs/developer-docs/docs/build-an-agent/host-your-agent.md`:
- Line 85: Replace the grammatically awkward sentence "The fastest way to make
sure your Agent is accessible is opening the public URL provided by the
hosting." with a corrected version—for example, "The fastest way to verify your
Agent is accessible is to open the public URL provided by your hosting
provider." Locate and update the sentence in host-your-agent.md (the sentence
shown in the diff) so capitalization of "Agent" follows project style and
wording uses "verify" and "to open" for clear grammar.
- Around line 63-67: Replace the incorrect build command "npm build" with the
correct "npm run build" in the documentation step that instructs setting the
build command (the block showing the npm command for building the project);
update the code block text so it matches the pattern used elsewhere (e.g., the
build script invocation as in warden-code.md) to ensure users run the
package.json "build" script.

In `@docs/developer-docs/docs/build-an-agent/introduction.md`:
- Around line 21-24: Fix the grammar in the "Open Agent ecosystem" paragraph:
change the sentence starting "Warden Agents generated with [Warden Code] aren't
limited with distribution on Warden." to "Warden Agents generated with [Warden
Code] are not limited to distribution on Warden." and change "They support open
standards such as the **A2A protocol**, **x402 payments**, and **ERC-8004
identity**, which allows them to function..." to use a plural verb or
gerund—e.g., "They support open standards such as the **A2A protocol**, **x402
payments**, and **ERC-8004 identity**, which allow them to function across the
broader Agent ecosystem." or "They support ... allowing them to function across
the broader Agent ecosystem." Ensure the phrases "[Warden Code]" and the list
"A2A protocol, x402 payments, and ERC-8004 identity" are updated accordingly.
- Around line 62-74: Fix the two typos in the introduction paragraph and the
"Register on ERC-8004" bullet: change "capablities" to "capabilities" in the
sentence starting "A list of key Warden Agent..." and update the bullet text
"Learn how register your Agent on ERC-8004 using Warden Code." to "Learn how to
register your Agent on ERC-8004 using Warden Code." (refer to the lines
containing the phrase "A list of key Warden Agent capablities" and the "Register
on ERC-8004" bullet).

In `@docs/developer-docs/docs/build-an-agent/publish-on-warden.md`:
- Line 29: Replace the incorrect phrase "First, sign it to
[Warden](https://app.wardenprotocol.org/home) and [fund your account]…" with
"First, sign in to [Warden](https://app.wardenprotocol.org/home) and [fund your
account]…" in the markdown sentence to correct the typo; locate the sentence
matching the exact string "First, sign it to
[Warden](https://app.wardenprotocol.org/home) and [fund your
account](https://help.wardenprotocol.org/warden-app/manage-your-wallets#deposit)."
and update "sign it to" → "sign in to".

In `@docs/developer-docs/docs/build-an-agent/register-on-erc-8004.md`:
- Line 7: Replace the "*Coming soon.*" placeholder in register-on-erc-8004.md
with a minimal actionable draft: add a short "Prerequisites" list (wallet,
network, contract ABI/address), a concise step-by-step "Register an Agent"
section that shows the sequence (connect wallet, prepare registration payload,
call the contract method like registerAgent or equivalent, wait for
confirmation) and example CLI/JSON parameters to submit, plus a "Verification"
step (check tx hash or call a view function) and links to the authoritative
ERC-8004 spec and the contract ABI; ensure clear headings and no placeholder
text remains.

In `@docs/developer-docs/docs/build-an-agent/warden-agent-capabilities.md`:
- Around line 25-31: The "Warden" markdown link in the sentence starting "All
Agents are immediately compatible with [Warden](...)" points to the help docs;
update that link target to the product/studio URL (e.g., https://warden.studio
or the official app destination) so the label and destination match; edit the
link markup in the same line to replace the help.wardenprotocol.org URL with the
app URL while keeping the link text "[Warden]" unchanged.

In `@docs/developer-docs/vercel.json`:
- Around line 74-75: The specific redirect for
{"source":"/publish-an-agent/publish-your-agent","destination":"/build-an-agent/publish-on-warden","statusCode":301}
is being shadowed by the wildcard
{"source":"/publish-an-agent/:path*","destination":"/build-an-agent/introduction","statusCode":301};
fix by moving the specific publish-your-agent redirect entry to appear before
the wildcard entry so the exact match is evaluated first.

---

Nitpick comments:
In
`@docs/developer-docs/docs/build-an-agent/build-an-agent/create-a-new-agent.md`:
- Around line 98-100: The existing warning in create-a-new-agent.md is ambiguous
about API key handling; update the warning block to explicitly instruct users
not to commit their .env file (do not check `.env` into version control), to
store API keys in deployment secret storage or environment variable managers for
production, and to use a local `.env` only for development—removing or rotating
keys before publishing; reference the warning block in this document to replace
the current text with this clearer guidance.

---

ℹ️ Review info

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7379b38 and 5ce0d9f.

⛔ Files ignored due to path filters (3)

• docs/developer-docs/static/img/warden-code-ui.png is excluded by !**/*.png
• docs/developer-docs/static/img/warden-studio-1.png is excluded by !**/*.png
• docs/developer-docs/static/img/warden-studio-2.png is excluded by !**/*.png

📒 Files selected for processing (27)

• docs/developer-docs/.spelling
• docs/developer-docs/docs/build-an-agent/build-an-agent/_category_.json
• docs/developer-docs/docs/build-an-agent/build-an-agent/configure-the-agent.md
• docs/developer-docs/docs/build-an-agent/build-an-agent/create-a-new-agent.md
• docs/developer-docs/docs/build-an-agent/build-an-agent/implement-custom-logic.md
• docs/developer-docs/docs/build-an-agent/build-an-agent/technical-requirements.md
• docs/developer-docs/docs/build-an-agent/build-an-agent/test-the-agent-locally.md
• docs/developer-docs/docs/build-an-agent/developer-tools/_category_.json
• docs/developer-docs/docs/build-an-agent/developer-tools/warden-code.md
• docs/developer-docs/docs/build-an-agent/developer-tools/warden-studio.md
• docs/developer-docs/docs/build-an-agent/host-your-agent.md
• docs/developer-docs/docs/build-an-agent/introduction.md
• docs/developer-docs/docs/build-an-agent/publish-on-warden.md
• docs/developer-docs/docs/build-an-agent/register-on-erc-8004.md
• docs/developer-docs/docs/build-an-agent/warden-agent-capabilities.md
• docs/developer-docs/docs/home.mdx
• docs/developer-docs/docs/learn/glossary.md
• docs/developer-docs/docs/learn/introduction-to-warden.md
• docs/developer-docs/docs/learn/warden-manifesto.md
• docs/developer-docs/docs/learn/whitepaper.md
• docs/developer-docs/docs/publish-an-agent/introduction.md
• docs/developer-docs/docs/publish-an-agent/publish-your-agent.md
• docs/developer-docs/docusaurus.config.ts
• docs/developer-docs/sidebars.ts
• docs/developer-docs/vercel.json
• docs/help-center/.spelling
• docs/help-center/docusaurus.config.ts

💤 Files with no reviewable changes (4)

• docs/developer-docs/docs/publish-an-agent/introduction.md
• docs/developer-docs/docs/publish-an-agent/publish-your-agent.md
• docs/developer-docs/.spelling
• docs/help-center/.spelling