sonar-docs

Update SonarQube product documentation across multiple versions and platforms.

1.3k|191|Updated May 15, 2012
One-click install
npx skills add https://github.com/SonarSource/SonarJS --skill sonar-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: sonar-docs
Source: https://github.com/SonarSource/SonarJS/tree/main/.claude/skills/sonar-docs
Command: npx skills add https://github.com/SonarSource/SonarJS --skill sonar-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This skill streamlines the editing of the SonarQube product documentation, ensuring consistency across multiple product versions and platforms.

Core Features & Use Cases

  • Multi-Version Documentation Management: Maintain and update documentation for different product versions of SonarQube.
  • Cross-Platform Editing: Supports editing for Cloud, Community, and Server platforms.
  • Markdown Formatting: Utilizes Markdown and GitBook conventions for documentation.

Quick Start

Use the sonar-docs skill to update the documentation for the "TypeScript configuration" section.

Frequently Asked Questions about sonar-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I update SonarQube documentation across multiple product versions?

Updating SonarQube documentation across multiple versions requires synchronizing content edits for Cloud, Community, and Server platforms. This approach maintains version consistency using Markdown and GitBook formatting conventions.

What is the best way to manage multi-version documentation synchronization for code analysis tools?

Multi-version documentation synchronization maintains version-specific content branches while applying shared updates consistently. This prevents configuration drift across JavaScript, TypeScript, and CSS analysis documentation.

Does editing SonarQube documentation require GitBook and Markdown skills?

Editing SonarQube documentation requires GitBook and Markdown skills to properly format content. These conventions are necessary for structuring JavaScript and TypeScript analysis guides correctly across different product platforms.

How do I edit JavaScript and TypeScript configuration sections in SonarQube docs?

Editing JavaScript and TypeScript configuration sections involves updating Markdown files following GitBook standards. This ensures the analysis documentation integrates seamlessly across Community, Server, and Cloud instances.

Can I use standard Markdown to maintain CSS analysis documentation for different SonarQube platforms?

You can use standard Markdown formatted with GitBook conventions to maintain CSS analysis documentation. This allows consistent document management across SonarQube Cloud, Community, and Server platforms.

Why does multi-version documentation synchronization matter for SonarQube code analysis?

Multi-version documentation synchronization prevents configuration discrepancies in code analysis features. Keeping SonarQube docs aligned ensures users access the correct JavaScript and CSS analysis rules per version.