Skip to content

improvements to ai docs#2839

Merged
atharvadeosthale merged 3 commits intomainfrom
ai-docs-improvements
Mar 31, 2026
Merged

improvements to ai docs#2839
atharvadeosthale merged 3 commits intomainfrom
ai-docs-improvements

Conversation

@atharvadeosthale
Copy link
Copy Markdown
Member

@atharvadeosthale atharvadeosthale commented Mar 30, 2026

Summary by CodeRabbit

  • Documentation
    • Updated AGENTS.md generator link to the canonical URL.
    • Added Zenflow (IDE) and Bolt entries to the AI tooling reference.
    • Reworked Vibe coding tool listings to separate light/dark theme renderings and include theme-specific logos.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 30, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: c28d727b-87ff-41aa-8a02-8adffc100eac

📥 Commits

Reviewing files that changed from the base of the PR and between 04c9bd4 and f509757.

📒 Files selected for processing (2)
  • src/routes/docs/tooling/ai/agents-md/+page.markdoc
  • src/routes/docs/tooling/ai/ai-dev-tools/+page.markdoc
✅ Files skipped from review due to trivial changes (1)
  • src/routes/docs/tooling/ai/agents-md/+page.markdoc
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/routes/docs/tooling/ai/ai-dev-tools/+page.markdoc

Walkthrough

Updated two Markdoc documentation pages. In src/routes/docs/tooling/ai/agents-md/+page.markdoc the AGENTS.md generator link was changed from https://agentsmd.appwrite.network/ to https://agentsmd.appwrite.io. In src/routes/docs/tooling/ai/ai-dev-tools/+page.markdoc the AGENTS.md link was updated, a Zenflow IDE card was added, Vibe coding tool cards were reworked into separate light and dark theme blocks (added Bolt and explicit theme-specific logo paths), and the file has no trailing newline.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'improvements to ai docs' is vague and generic. While it references AI docs which are involved in the changes, it doesn't specify what improvements were made (URL updates, Zenflow addition, theme separation, etc.) and would not clearly inform a reviewer of the actual changes without reviewing the full PR. Consider a more descriptive title such as 'Update AI docs: Fix URLs, add Zenflow IDE, and improve theme-specific content' to better convey the specific improvements made.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
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 unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch ai-docs-improvements

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.

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.

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 `@src/routes/docs/tooling/ai/agents-md/`+page.markdoc:
- Line 21: Replace the broken URL in the line containing "AGENTS.md generator"
by updating the link target from https://agentsmd.appwrite.io to a working
generator (e.g., https://agentsmd.online) or revert to the previous known-good
URL; locate the exact string "Use the [AGENTS.md
generator](https://agentsmd.appwrite.io) to create a custom `AGENTS.md` file for
your project." and change only the URL portion so the markdown link points to a
resolvable domain.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: bf79fba5-fca5-47c3-ad18-2695f9c187a7

📥 Commits

Reviewing files that changed from the base of the PR and between f17038d and 2b70194.

⛔ Files ignored due to path filters (8)
  • static/images/docs/mcp/logos/bolt.svg is excluded by !**/*.svg
  • static/images/docs/mcp/logos/dark/bolt.svg is excluded by !**/*.svg
  • static/images/docs/mcp/logos/dark/emergent.svg is excluded by !**/*.svg
  • static/images/docs/mcp/logos/dark/imagine.svg is excluded by !**/*.svg
  • static/images/docs/mcp/logos/dark/lovable.svg is excluded by !**/*.svg
  • static/images/docs/mcp/logos/emergent.svg is excluded by !**/*.svg
  • static/images/docs/mcp/logos/imagine.svg is excluded by !**/*.svg
  • static/images/docs/mcp/logos/lovable.svg is excluded by !**/*.svg
📒 Files selected for processing (2)
  • src/routes/docs/tooling/ai/agents-md/+page.markdoc
  • src/routes/docs/tooling/ai/ai-dev-tools/+page.markdoc

# Generate AGENTS.md {% #generate %}

Use the [AGENTS.md generator](https://agentsmd.appwrite.network/) to create a custom `AGENTS.md` file for your project.
Use the [AGENTS.md generator](https://agentsmd.appwrite.io) to create a custom `AGENTS.md` file for your project.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Description: Verify the new AGENTS.md generator URL is accessible

# Test: Check if the new URL responds successfully
curl -sI "https://agentsmd.appwrite.io" | head -20

Repository: appwrite/website

Length of output: 42


🏁 Script executed:

#!/bin/bash
# Test the new URL with explicit status code and verbose error handling
echo "Testing https://agentsmd.appwrite.io..."
curl -sL -w "\nHTTP Status: %{http_code}\n" -o /dev/null --max-time 5 "https://agentsmd.appwrite.io"
echo "Exit code: $?"

Repository: appwrite/website

Length of output: 130


🌐 Web query:

agentsmd.appwrite.io AGENTS.md generator

💡 Result:

No evidence found of agentsmd.appwrite.io existing as a live website or official Appwrite service. The domain does not appear in search results across general web, GitHub, or company directories. AGENTS.md is an open Markdown standard for providing AI coding agents (e.g., Claude Code, Cursor, GitHub Copilot) with repo-specific instructions like build commands, architecture, and conventions. Appwrite repositories use AGENTS.md files, such as in appwrite/console (detailed SvelteKit project instructions) and appwrite/sdk-generator. Appwrite also provides agent-skills (language-specific instruction packs installable via npx skills add appwrite/agent-skills) following agentskills.io standards. General AGENTS.md generators exist (e.g., agentsmd.abvx.xyz CLI for safe updates, puredevtools.tools visual editor, Paldom/agents-init CLI), but none are Appwrite-hosted or at agentsmd.appwrite.io. Appwrite's sdk-generator auto-generates SDKs from specs, not AGENTS.md files.

Citations:


The new URL https://agentsmd.appwrite.io is broken and unresolvable.

DNS resolution fails (CURLE_COULDNT_RESOLVE_HOST), and web search confirms the domain does not exist as a live Appwrite service. The documentation link will break for users. Either revert to the original URL, point to an existing AGENTS.md generator (e.g., agentsmd.online), or delay this change until the new domain is live.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@src/routes/docs/tooling/ai/agents-md/`+page.markdoc at line 21, Replace the
broken URL in the line containing "AGENTS.md generator" by updating the link
target from https://agentsmd.appwrite.io to a working generator (e.g.,
https://agentsmd.online) or revert to the previous known-good URL; locate the
exact string "Use the [AGENTS.md generator](https://agentsmd.appwrite.io) to
create a custom `AGENTS.md` file for your project." and change only the URL
portion so the markdown link points to a resolvable domain.

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps bot commented Mar 30, 2026

Greptile Summary

This PR improves the AI dev tools documentation by normalizing the AGENTS.md generator URL (from agentsmd.appwrite.network to agentsmd.appwrite.io), adding Zenflow to the IDEs section with proper light/dark theme logos, and reworking the Vibe coding tools listing to use separate {% only_light %} / {% only_dark %} blocks with theme-specific SVG logos — also adding Bolt to the list.

  • Updated AGENTS.md generator URL in both agents-md/+page.markdoc and ai-dev-tools/+page.markdoc.
  • Added Zenflow card to the IDEs section for both light and dark themes; the linked page and both SVG assets already exist in the repo.
  • Converted the previously logo-less Vibe coding cards (Imagine, Lovable, Emergent) to use separate light/dark theme wrappers and added the new Bolt entry.
  • Added 8 new SVG logo files (light + dark variants for Bolt, Emergent, Imagine, Lovable) following the existing convention.

Confidence Score: 5/5

This PR is safe to merge — all changes are documentation and static asset additions with no functional code impact.

All referenced SVG assets and linked pages exist in the repository. The light/dark theme variants follow established patterns. No logic, configuration, or runtime code is modified.

No files require special attention.

Important Files Changed

Filename Overview
src/routes/docs/tooling/ai/agents-md/+page.markdoc URL updated from agentsmd.appwrite.network to agentsmd.appwrite.io — straightforward domain normalization.
src/routes/docs/tooling/ai/ai-dev-tools/+page.markdoc Adds Zenflow to IDEs section, updates Vibe coding section with light/dark theme variants, adds Bolt, and updates generator URL.
static/images/docs/mcp/logos/bolt.svg New Bolt logo SVG for light theme with correct dark fill.
static/images/docs/mcp/logos/dark/bolt.svg New Bolt logo SVG for dark theme with correct light fill.
static/images/docs/mcp/logos/imagine.svg New Imagine logo SVG for light theme.
static/images/docs/mcp/logos/dark/imagine.svg New Imagine logo SVG for dark theme.
static/images/docs/mcp/logos/lovable.svg New Lovable logo SVG for light theme.
static/images/docs/mcp/logos/dark/lovable.svg New Lovable logo SVG for dark theme.
static/images/docs/mcp/logos/emergent.svg New Emergent logo SVG for light theme.
static/images/docs/mcp/logos/dark/emergent.svg New Emergent logo SVG for dark theme.

Reviews (2): Last reviewed commit: "use io domain for agents md" | Re-trigger Greptile

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.

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 `@src/routes/docs/tooling/ai/ai-dev-tools/`+page.markdoc:
- Line 81: Rewrite the awkward sentence "Generate your own `AGENTS.md` file
depending on the Appwrite services you use in your application using the
[AGENTS.md generator](https://agentsmd.appwrite.network)." to a tighter version
that removes the double "using" and clarifies intent—e.g., "Use the [AGENTS.md
generator](https://agentsmd.appwrite.network) to create an `AGENTS.md` file
tailored to the Appwrite services your application uses." Replace the original
sentence in +page.markdoc (the line containing "AGENTS.md generator") with this
improved wording.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 1a1c3fb7-233a-4c63-aee1-51b57900fe82

📥 Commits

Reviewing files that changed from the base of the PR and between 2b70194 and 04c9bd4.

📒 Files selected for processing (2)
  • src/routes/docs/tooling/ai/agents-md/+page.markdoc
  • src/routes/docs/tooling/ai/ai-dev-tools/+page.markdoc
✅ Files skipped from review due to trivial changes (1)
  • src/routes/docs/tooling/ai/agents-md/+page.markdoc

When an AI agent encounters an `AGENTS.md` file, it uses the instructions to tailor its responses to your specific project requirements. This includes details about your tech stack, file organization, naming conventions, and architectural patterns.

Generate your own `AGENTS.md` file depending on the Appwrite services you use in your application using the [AGENTS.md generator](https://agentsmd.appwrite.network/).
Generate your own `AGENTS.md` file depending on the Appwrite services you use in your application using the [AGENTS.md generator](https://agentsmd.appwrite.network).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Tighten phrasing for the AGENTS.md generator sentence.

Line 81 reads awkwardly (“depending on … using …”). A small copy edit will improve clarity.

✏️ Proposed wording tweak
-Generate your own `AGENTS.md` file depending on the Appwrite services you use in your application using the [AGENTS.md generator](https://agentsmd.appwrite.network).
+Generate your own `AGENTS.md` file based on the Appwrite services used in your application with the [AGENTS.md generator](https://agentsmd.appwrite.network).
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Generate your own `AGENTS.md` file depending on the Appwrite services you use in your application using the [AGENTS.md generator](https://agentsmd.appwrite.network).
Generate your own `AGENTS.md` file based on the Appwrite services used in your application with the [AGENTS.md generator](https://agentsmd.appwrite.network).
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@src/routes/docs/tooling/ai/ai-dev-tools/`+page.markdoc at line 81, Rewrite
the awkward sentence "Generate your own `AGENTS.md` file depending on the
Appwrite services you use in your application using the [AGENTS.md
generator](https://agentsmd.appwrite.network)." to a tighter version that
removes the double "using" and clarifies intent—e.g., "Use the [AGENTS.md
generator](https://agentsmd.appwrite.network) to create an `AGENTS.md` file
tailored to the Appwrite services your application uses." Replace the original
sentence in +page.markdoc (the line containing "AGENTS.md generator") with this
improved wording.

@atharvadeosthale atharvadeosthale merged commit f1187d6 into main Mar 31, 2026
7 checks passed
@atharvadeosthale atharvadeosthale deleted the ai-docs-improvements branch March 31, 2026 12:23
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