Skip to content
Prompt

content-sdk — Windsurf Rules

by Sitecore

AI Summary

Windsurf AI rules for the Sitecore Content SDK that guide developers on project structure, TypeScript conventions, and best practices for building XM Cloud applications. Developers building Sitecore sites with modern tooling benefit from clear architectural guidance and coding standards.

Install

Copy this and paste it into Claude Code, Cursor, or any AI assistant:

I want to add the "content-sdk — Windsurf Rules" prompt rules to my project.
Repository: https://github.com/Sitecore/content-sdk

Please read the repo to find the rules/prompt file, then:
1. Download it to the correct location (.cursorrules, .windsurfrules, .github/prompts/, or project root — based on the file type)
2. If there's an existing rules file, merge the new rules in rather than overwriting
3. Confirm what was added

Description

The Content SDK to support building sites with XM Cloud

Project Overview

This is the Sitecore Content SDK - a comprehensive TypeScript/JavaScript SDK for building modern web applications with Sitecore XM Cloud. The project provides core functionality, React components, Next.js integration, and CLI tools for scaffolding applications.

Tech Stack

• Language: TypeScript (Node LTS) • Runtime: Node LTS • Build: tsc -> dist/, templates bundled via scripts/build-templates.ts • Testing: Mocha + Sinon + Chai, coverage via nyc • Lint/format: ESLint + Prettier • Package Manager: Yarn 3.1.0

Core Packages

• @sitecore-content-sdk/core - Core SDK functionality • @sitecore-content-sdk/react - React-specific SDK • @sitecore-content-sdk/nextjs - Next.js integration and middleware • @sitecore-content-sdk/cli - CLI tools and scaffolding • create-content-sdk-app - Scaffolding CLI & templates

Repository Structure

` content-sdk/ ├── packages/ │ ├── create-content-sdk-app/ # Scaffolding CLI & templates │ ├── core/ # Core SDK functionality │ ├── nextjs/ # Next.js-specific SDK │ ├── react/ # React-specific SDK │ └── cli/ # Additional CLI tools └── samples/ # Example applications `

Discussion

0/2000
Loading comments...

Health Signals

MaintenanceCommitted 1mo ago
Active
AdoptionUnder 100 stars
31 ★ · Niche
DocsMissing or thin
Undocumented

GitHub Signals

Stars31
Forks24
Issues9
Updated1mo ago
View on GitHub
Apache-2.0 License

My Fox Den

Community Rating

Sign in to rate this booster

Works With

Any AI assistant that accepts custom rules or system prompts

Claude
ChatGPT
Cursor
Windsurf
Copilot
+ more