Skip to content

Add Cursor get-started and contribute guides for the site#53

Open
bburt-rh wants to merge 5 commits intoredhat-documentation:mainfrom
bburt-rh:feature/cursor-docs-site
Open

Add Cursor get-started and contribute guides for the site#53
bburt-rh wants to merge 5 commits intoredhat-documentation:mainfrom
bburt-rh:feature/cursor-docs-site

Conversation

@bburt-rh
Copy link
Collaborator

@bburt-rh bburt-rh commented Mar 20, 2026

Adds Cursor documentation for the web site

Summary by CodeRabbit

  • Documentation
    • Added comprehensive Cursor guides: fundamentals, product-documentation workflow, contributor tools, and Cursor-specific workflows.
    • Updated README and homepage to cover both Claude Code and Cursor and added a “Get Started with Cursor” section.
    • Expanded CONTRIBUTING with Cursor guidance and contributor best practices.
    • Revised quick-start to use Claude CLI commands and clarified install/command usage.
    • Updated site navigation and documentation build/preview instructions.

@coderabbitai
Copy link

coderabbitai bot commented Mar 20, 2026

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 04eae209-3087-4ccd-8692-0f90c5c61bb2

📥 Commits

Reviewing files that changed from the base of the PR and between 268053c and 292aef3.

📒 Files selected for processing (1)
  • docs/get-started/cursor-fundamentals.md

📝 Walkthrough

Walkthrough

This PR adds Cursor-focused documentation and site navigation, updates README/CONTRIBUTING to cover both Claude Code and Cursor workflows, adjusts quick-start and CLI examples, and updates zensical site config and markdown rendering settings. Multiple new Cursor how-to and workflow docs are introduced.

Changes

Cohort / File(s) Summary
Cursor Getting‑Started & Fundamentals
docs/get-started/index.md, docs/get-started/cursor-fundamentals.md, docs/get-started/cursor-product-documentation.md
Added Cursor onboarding and fundamentals, multi-root/multi-repo usage guidance, workflow for using Agent Tools from a separate docs repo, examples, and troubleshooting.
Cursor Contribution Guides
docs/contribute/cursor-contributing-tools.md, docs/contribute/cursor-workflows.md, docs/contribute/index.md, CONTRIBUTING.md
New contributor workflows for Cursor, repository-root-relative script/path guidance (instead of ${CLAUDE_PLUGIN_ROOT}), instructions for evals/evals.json and PR verification checklists, and mapping differences vs Claude Code.
README & Quick Start
README.md, docs/quick-start.md, docs/index.md
Expanded README to document both Claude Code and Cursor usage, revised quick-start examples to use claude plugin CLI and Claude Code namespaced commands, added Cursor get-started links and UI card; minor formatting/format-type fence updates.
Site Configuration & Rendering
zensical.toml
Updated site description and navigation to include Cursor sections under “Get Started with Cursor” and “Contribute”; added custom_fences entry to support mermaid in docs rendering.
Contributing / Minor formatting
CONTRIBUTING.md (also noted above)
Inserted a dedicated “Cursor users” section, adjusted markdown headings/table separators, clarified command wording and code-fence language to text across docs.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Poem

🐰 I hopped through docs with a twitch and a cheer,
Added Cursor trails so contributors see clear,
AGENTS and skills now attach with an @,
Two tools in one meadow — and a jaunty hat! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly and accurately summarizes the main change: adding Cursor get-started and contribute guides to the documentation site.
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

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

Copy link

@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 `@docs/cursor-skills-index.md`:
- Line 41: The table row for skill `docs-review-content-quality` has an
unmatched double-quote in the description (the fragment `"make it more
concise.`) — open docs/cursor-skills-index.md, locate the
`docs-review-content-quality` row and fix the typo by closing or removing the
stray double-quote so the phrase is balanced (e.g., ...or "make it more
concise." or ...or make it more concise.), ensuring the Markdown table cell's
quotes are properly matched.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 03c79c5b-79aa-4595-8287-41b783e8f191

📥 Commits

Reviewing files that changed from the base of the PR and between 0886240 and 48bf9c0.

📒 Files selected for processing (11)
  • CONTRIBUTING.md
  • README.md
  • docs/contribute/cursor-contributing-tools.md
  • docs/contribute/cursor-workflows.md
  • docs/contribute/index.md
  • docs/cursor-skills-index.md
  • docs/get-started/cursor-fundamentals.md
  • docs/get-started/cursor-product-documentation.md
  • docs/get-started/index.md
  • docs/index.md
  • docs/quick-start.md
✅ Files skipped from review due to trivial changes (5)
  • docs/get-started/index.md
  • docs/contribute/index.md
  • docs/contribute/cursor-contributing-tools.md
  • docs/contribute/cursor-workflows.md
  • docs/get-started/cursor-product-documentation.md
🚧 Files skipped from review as they are similar to previous changes (4)
  • docs/quick-start.md
  • docs/index.md
  • README.md
  • CONTRIBUTING.md

Copy link

@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 `@docs/get-started/cursor-fundamentals.md`:
- Line 50: Replace the sentence "The available agentic models available varies."
by removing the duplicate "available" and fixing subject-verb agreement; for
example change it to "The available agentic models vary." (or "Agentic models
available vary.") so the grammar is correct and the rest of the paragraph about
the default "Auto" model remains unchanged.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: fbf5767d-886c-4f74-9562-054ee8b10da8

📥 Commits

Reviewing files that changed from the base of the PR and between 78067c5 and 268053c.

📒 Files selected for processing (5)
  • README.md
  • docs/contribute/cursor-contributing-tools.md
  • docs/contribute/cursor-workflows.md
  • docs/get-started/cursor-fundamentals.md
  • docs/get-started/cursor-product-documentation.md
✅ Files skipped from review due to trivial changes (3)
  • docs/contribute/cursor-contributing-tools.md
  • docs/contribute/cursor-workflows.md
  • docs/get-started/cursor-product-documentation.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md

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