Name: *
Author: kp-cat

Instruction file imported from kp-cat/configcat-docs (.github/instructions/*.instructions.md). Copyright stays with the author.

Project Overview

This is the ConfigCat documentation repository, a Docusaurus-based documentation site for ConfigCat's feature flag and configuration management service. The site is available at https://configcat.com/docs.

Architecture

Key Technologies

Docusaurus 3.8+
TypeScript
OpenAPI docs plugins
- Public Management API: https://api.configcat.com/docs/v1/swagger.json
- SCIM API: https://scim-api.configcat.com/openapi/v1/openapi.json
Algolia
SASS

Documentation Versioning

The site maintains two versions:

Config V2 (current) - Default version at /docs/
Config V1 (legacy) - Available at /docs/V1/, excluded from sitemap

Directory Structure

website/docs/ - Main documentation content (MDX files)
- sdk-reference/ - Documentation of ConfigCat SDKs for various platforms
- integrations/ - Integration guides
- advanced/ - Guides on advanced topics
- targeting/ - Targeting and feature flag evaluation docs
- glossary/ - Glossary of terms
website/api/ - ConfigCat Public Management API documentation content
website/src/ - React components, custom CSS, and plugins
- components/ - Reusable React components
- schema-markup/ - JSON-LD schema markup files for SEO
- pages/ - Custom pages
- css/ - Custom SCSS styles
website/static/ - Static assets (images, etc.)
website/versioned_docs/ - Config V1 documentation
website/sidebars.ts - Main sidebar configuration (defines navigation structure)
website/docusaurus.config.ts - Docusaurus configuration

Important Configuration Details

Base URL: /docs/ (not root)
Trailing slashes: Enabled
Multi-language support: Configured but only English enabled

Review Focus

When reviewing documentation changes, check for:

Typos and grammatical errors.
Adherence to the writing style and text formatting guidelines defined by ConfigCat's Guidelines for Text.
Accuracy of any code snippets or technical instructions.

{ "ocm": "1", "id": "kp-cat-configcat-docs-instructions", "kind": "skill", "name": "*", "description": "This is the ConfigCat documentation repository, a Docusaurus-based documentation site for ConfigCat's feature flag and configuration management service. The site is available at https://configcat.com/docs.", "publisher": "kp-cat", "version": "1.0.0", "capabilities": { "domains": [ "general" ], "tags": [ "skill-md", "github-instructions" ], "languages": [ "en" ] }, "quality_prior": 0.6, "examples": [ "This is the ConfigCat documentation repository, a Docusaurus-based documentation site for ConfigCat's feature flag and configuration management service. The site is available at https://configcat.com/docs." ], "primary": false, "metadata": { "source": { "provider": "github-instructions", "repository": "https://github.com/kp-cat/configcat-docs", "path": ".github/instructions/*.instructions.md", "ref": "9be3cd9720591a0360509fce5a247af2e6a6007d", "url": "https://github.com/kp-cat/configcat-docs/blob/9be3cd9720591a0360509fce5a247af2e6a6007d/.github/instructions/*.instructions.md", "key": "kp-cat/configcat-docs/.github/instructions/*.instructions.md" } }, "instructions": "## Project Overview\n\nThis is the ConfigCat documentation repository, a Docusaurus-based documentation site for ConfigCat's feature flag and configuration management service. The site is available at https://configcat.com/docs.\n\n## Architecture\n\n### Key Technologies\n\n- **Docusaurus 3.8+**\n- **TypeScript**\n- **OpenAPI docs plugins**\n - Public Management API: https://api.configcat.com/docs/v1/swagger.json\n - SCIM API: https://scim-api.configcat.com/openapi/v1/openapi.json\n- **Algolia**\n- **SASS**\n\n### Documentation Versioning\n\nThe site maintains two versions:\n- **Config V2** (current) - Default", "cost": { "context_tokens": 522 } }

*

About

Project Overview

Architecture

Key Technologies

Documentation Versioning

Directory Structure

Important Configuration Details

Review Focus

Use it

Manifest

Reviews