Skip to content

docs: add verified agent quickstarts#486

Merged
mohanagy merged 1 commit into
nextfrom
issue-473-agent-quickstarts-smoke-tests
Jun 2, 2026
Merged

docs: add verified agent quickstarts#486
mohanagy merged 1 commit into
nextfrom
issue-473-agent-quickstarts-smoke-tests

Conversation

@mohanagy
Copy link
Copy Markdown
Owner

@mohanagy mohanagy commented Jun 2, 2026

Summary\n- add a verified agent quickstarts page for Claude, Cursor, Copilot CLI, Gemini CLI, Codex CLI, Aider, and OpenCode\n- link the quickstarts from README and the install compatibility guide, including the trial-flow tutorial path\n- extend install docs tests so the quickstarts stay aligned with the generated install/config contract\n\n## Testing\n- npm run test:run -- tests/unit/install-compatibility.test.ts\n- npm run typecheck\n- npm run build\n- CI=1 npm run test:run\n\nRefs #473

Summary by CodeRabbit

  • Documentation
    • Added comprehensive agent quickstart guides with verified step-by-step installation and setup instructions for multiple supported agent integrations.
    • Updated main documentation navigation and compatibility guide to direct users to the new quickstart guides.
    • Each guide includes expected outputs, verification steps, smoke-test commands, known limitations, and detailed troubleshooting guidance for common setup issues.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jun 2, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

This PR adds a new agent quickstarts documentation guide providing verified install instructions for seven AI agent platforms (Claude Code, Cursor, GitHub Copilot CLI, Gemini CLI, Codex CLI, Aider, OpenCode). The guide is linked from README and the compatibility matrix, and test coverage validates that each platform's quickstart content is present and complete.

Changes

Agent Quickstarts Documentation and Integration

Layer / File(s) Summary
Agent quickstarts guide content
docs/tutorials/agent-quickstarts.md
New page with standardized baseline trial flow and verified quickstart instructions for each supported agent: exact madar <agent> install command, expected generated/configured files, verification steps (madar doctor/madar status), copy/paste smoke-test command, plus per-agent known limitations and common failure modes. Also documents unsupported agents (VS Code + GitHub Copilot extension) and excluded products lacking repo-local verification proof.
README and compatibility guide links
README.md, docs/integrations/compatibility.md
Updates README.md install details sentence to reference agent quickstarts and adds Agent quickstarts row to documentation table. Adds compatibility guide instruction directing users to quickstarts walkthrough after selecting an install matrix row.
Quickstarts content validation tests
tests/unit/install-compatibility.test.ts
Defines PRIMARY_QUICKSTART_PLATFORMS set to filter which dedicated command rows must appear in quickstarts. Introduces test validating README references quickstarts, checking for required onboarding strings (including "Agent quickstarts", "madar try", smoke-test, and failure-mode headings), then iterating over filtered primary platform rows to assert label, command, doc artifacts, verification guidance, and limitation text all appear in the quickstarts document.

Possibly Related Issues

  • mohanagy/madar#473: This PR implements the verified agent-specific quickstarts feature with comprehensive documentation, README links, and test coverage that directly address the requirements described in the issue.

Possibly Related PRs

  • mohanagy/madar#442: This PR extends the install-compatibility documentation contract by adding the new agent quickstarts page, linking it from README and compatibility guide, and augmenting test coverage to validate quickstarts content per platform row—building directly on PR #442's install compatibility infrastructure and verification testing.

Estimated Code Review Effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 A quickstart for agents, all bundled with care,
Seven platforms verified, install steps laid bare,
Links from README guide the curious folk,
Tests ensure the docs won't break or choke!
Copy, paste, and generate—the docs promise made! 📚✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title concisely and accurately summarizes the main change: adding verified agent quickstarts documentation.
Description check ✅ Passed The description covers the summary, testing steps, and includes most checklist items, though some checkboxes are not explicitly marked.
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 issue-473-agent-quickstarts-smoke-tests

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

Copy link
Copy Markdown

@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 (2)
docs/tutorials/agent-quickstarts.md (2)

158-158: ⚡ Quick win

Add trailing newline at end of file.

The file should end with a newline character for better POSIX compliance and cleaner diffs.

🤖 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 `@docs/tutorials/agent-quickstarts.md` at line 158, The file
docs/tutorials/agent-quickstarts.md is missing a trailing newline; edit that
file and add a single newline character at the end of the file (ensure the file
ends with '\n') so it conforms to POSIX conventions and produces cleaner diffs.

24-24: 💤 Low value

Minor grammar improvement in smoke-test query.

The example query "how does password reset request enqueue the reset email" is missing an article. Consider:

  • "how does a password reset request enqueue the reset email"
  • "how does the password reset request enqueue the reset email"

This appears in all seven agent quickstart sections.

✏️ Example fix for one section
-madar pack "how does password reset request enqueue the reset email" --task explain
+madar pack "how does a password reset request enqueue the reset email" --task explain

Also applies to: 44-44, 64-64, 84-84, 104-104, 124-124, 144-144

🤖 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 `@docs/tutorials/agent-quickstarts.md` at line 24, Fix the smoke-test query
strings in docs/tutorials/agent-quickstarts.md by adding the missing article to
each occurrence of the example query "how does password reset request enqueue
the reset email" (appearing at the seven locations referenced) — change them to
a consistent phrasing such as "how does a password reset request enqueue the
reset email" (or "the" if project prefers); update all seven instances so the
string used in the examples/test commands (e.g., madar pack "how does password
reset request enqueue the reset email" --task explain) is replaced with the
corrected phrasing.
🤖 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 `@docs/tutorials/agent-quickstarts.md`:
- Line 158: The file docs/tutorials/agent-quickstarts.md is missing a trailing
newline; edit that file and add a single newline character at the end of the
file (ensure the file ends with '\n') so it conforms to POSIX conventions and
produces cleaner diffs.
- Line 24: Fix the smoke-test query strings in
docs/tutorials/agent-quickstarts.md by adding the missing article to each
occurrence of the example query "how does password reset request enqueue the
reset email" (appearing at the seven locations referenced) — change them to a
consistent phrasing such as "how does a password reset request enqueue the reset
email" (or "the" if project prefers); update all seven instances so the string
used in the examples/test commands (e.g., madar pack "how does password reset
request enqueue the reset email" --task explain) is replaced with the corrected
phrasing.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 0fa6ac83-1017-4f16-b28a-8754f823922b

📥 Commits

Reviewing files that changed from the base of the PR and between 5158392 and b1e4654.

📒 Files selected for processing (4)
  • README.md
  • docs/integrations/compatibility.md
  • docs/tutorials/agent-quickstarts.md
  • tests/unit/install-compatibility.test.ts

@mohanagy mohanagy merged commit 0c734b5 into next Jun 2, 2026
7 checks passed
@mohanagy mohanagy deleted the issue-473-agent-quickstarts-smoke-tests branch June 2, 2026 21:50
@coderabbitai coderabbitai Bot mentioned this pull request Jun 3, 2026
9 tasks
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