Skip to content

docs: add coding-agent installation and quickstart guides#486

Merged
peteski22 merged 1 commit into
mainfrom
docs/agent-install-guide
Jul 2, 2026
Merged

docs: add coding-agent installation and quickstart guides#486
peteski22 merged 1 commit into
mainfrom
docs/agent-install-guide

Conversation

@peteski22

@peteski22 peteski22 commented Jul 2, 2026

Copy link
Copy Markdown
Collaborator

Summary

Adds a customer-facing installation guide and a quickstart guide to the docs site, and restructures the introduction so installation leads and reference material moves down.

New pages

  • docs/install.md — installation guide for all seven supported hosts. Documents the files each cq install --target manages, uses per-host tabs for setup, and covers pointing an agent at a remote server via CQ_ADDR/CQ_API_KEY. Restores the Copilot/VS Code and Codex coverage dropped when the Python installer was retired.
  • docs/quickstart.md — the hands-on walkthrough (verify the plugin, add your first knowledge unit, check the store), moved out of the README.

README / introduction

  • Lead with Installation; link the CLI-binary install to the CLI README and the agent install to the new guide.
  • Move the walkthrough into the quickstart guide.
  • Move the "Published components and tags" reference table down.
  • Cross-link remote-storage configuration to the per-host section of the guide; fix a statsstatus tool-name typo.

DEVELOPMENT.md

  • Replace the agent-install how-to and per-host configuration sections with pointers to the new guide.

Navigation

  • Add both pages to docs/SUMMARY.md under Guides.

Verification

  • scripts/check_docs.py passes (all internal links and anchors resolve).
  • scripts/prepare_gitbook_site.py builds cleanly; the GitBook tab blocks and rewritten links were verified in the generated site.

Note

Publishes to docs.mozilla.ai/cq only after merge and a docs/vX.Y.Z release (per the docs workflow); the PR itself runs the docs validation job.

Summary by CodeRabbit

  • Documentation
    • Simplified the main README and development guide, with clearer pointers to installation, quickstart and remote-server setup docs.
    • Added a new installation guide covering setup across supported coding agents and Windows.
    • Added a quickstart guide showing how to verify the integration and add a first knowledge item.
    • Updated the table of contents to include the new guides.
    • Clarified when an API key is needed for read-only versus write actions.

Add a customer-facing installation guide (docs/install.md) covering the
seven supported hosts: the files each 'cq install --target' manages,
per-host tabs for setup, and how to point an agent at a remote server via
CQ_ADDR and CQ_API_KEY. This restores the Copilot/VS Code and Codex
coverage that was dropped when the Python installer was retired.

Move the hands-on walkthrough (verify, add first knowledge unit, check
store) out of the README into a dedicated quickstart guide, and relocate
the agent-install and per-host configuration content out of DEVELOPMENT.md
so those pages point at the guide instead.

Restructure the introduction to lead with installation and move the
components-and-tags reference table down. Wire both new pages into
docs/SUMMARY.md under Guides.
@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: a132cd23-7e58-4610-924e-184f35b14753

📥 Commits

Reviewing files that changed from the base of the PR and between 4b3bfee and 5686848.

📒 Files selected for processing (5)
  • DEVELOPMENT.md
  • README.md
  • docs/SUMMARY.md
  • docs/install.md
  • docs/quickstart.md

Walkthrough

Documentation is restructured: new docs/install.md and docs/quickstart.md guides are added, docs/SUMMARY.md is updated with corresponding TOC entries, and README.md/DEVELOPMENT.md are condensed to reference these guides instead of embedding detailed CLI/configuration instructions.

Changes

Documentation restructuring

Layer / File(s) Summary
New installation guide
docs/install.md
Adds end-to-end per-host installation documentation covering Claude Code, Codex, Copilot, Cursor, OpenCode, Pi, Windsurf, Windows setup, remote configuration, and advanced installer environment variables.
New quickstart guide
docs/quickstart.md
Adds a guide for verifying the plugin, adding a first knowledge unit via cq:propose, re-checking the store, and links to follow-up docs.
Table of contents update
docs/SUMMARY.md
Adds "Installation" and "Quickstart" entries under the Guides section.
README installation rework
README.md
Restructures the Installation section to link to the new install guide, updates the environment variable table for CQ_API_KEY/CQ_ADDR, and repositions the "Published components and tags" section.
DEVELOPMENT.md simplification
DEVELOPMENT.md
Condenses install and local agent configuration instructions into links pointing to docs/install.md.

Suggested labels: cli

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/agent-install-guide

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.

@peteski22 peteski22 merged commit cb1f81f into main Jul 2, 2026
2 of 3 checks passed
@peteski22 peteski22 deleted the docs/agent-install-guide branch July 2, 2026 17:11
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