docs: add coding-agent installation and quickstart guides#486
Merged
Conversation
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.
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (5)
WalkthroughDocumentation is restructured: new ChangesDocumentation restructuring
Suggested labels: ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 eachcq install --targetmanages, uses per-host tabs for setup, and covers pointing an agent at a remote server viaCQ_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
stats→statustool-name typo.DEVELOPMENT.md
Navigation
docs/SUMMARY.mdunder Guides.Verification
scripts/check_docs.pypasses (all internal links and anchors resolve).scripts/prepare_gitbook_site.pybuilds cleanly; the GitBook tab blocks and rewritten links were verified in the generated site.Note
Publishes to
docs.mozilla.ai/cqonly after merge and adocs/vX.Y.Zrelease (per the docs workflow); the PR itself runs the docs validation job.Summary by CodeRabbit