questdb-docs-writer

Create and review QuestDB documentation with SQL syntax and quality checks.

13|42|Updated Oct 3, 2023
One-click install
npx skills add https://github.com/questdb/documentation --skill questdb-docs-writer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: questdb-docs-writer
Source: https://github.com/questdb/documentation/tree/main/.claude/skills/questdb-docs-writer
Command: npx skills add https://github.com/questdb/documentation --skill questdb-docs-writer

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires python, and includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill simplifies the creation, review, and enhancement of QuestDB documentation, streamlining the process of maintaining accurate and user-friendly documentation.

Core Features & Use Cases

  • Documentation Creation: Facilitates the writing of new documentation pages, ensuring compliance with formatting and content standards.
  • Review Process: Enables thorough review of existing pages for accuracy, clarity, and adherence to best practices.
  • Syntax and Formatting: Ensures proper syntax highlighting for QuestDB SQL, adheres to Markdown and YAML frontmatter requirements.
  • Use Case: A team of developers can use this Skill to write and maintain SQL reference pages, guides, and cookbooks within the QuestDB documentation repository.

Quick Start

Run the 'questdb-docs-writer' skill to start the documentation creation and review process.

Frequently Asked Questions about questdb-docs-writer

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

FAQPage Schema
How do I automate QuestDB documentation creation and review for SQL syntax?

To automate QuestDB documentation creation and review, this Skill validates SQL syntax, enforces Markdown and YAML frontmatter standards, and runs quality checks. It streamlines writing new pages and reviewing existing ones for structure and accuracy.

What is the best way to ensure SQL syntax highlighting and formatting in QuestDB docs?

The best way to ensure SQL syntax highlighting and formatting in QuestDB docs is using this Skill. It automatically verifies proper syntax highlighting for QuestDB SQL and enforces adherence to Markdown and YAML frontmatter requirements.

Do I need Python to write and review QuestDB documentation?

Yes, you need Python to write and review QuestDB documentation with this Skill. Python is required for executing the internal scripts and generating the diagrams needed for the documentation pages.

Can I use this tool to review existing Markdown pages in the QuestDB documentation repository?

Yes, you can use this tool to review existing Markdown pages in the QuestDB documentation repository. It performs thorough reviews for accuracy, clarity, and adherence to best practices, ensuring your content meets quality standards.

How do I generate diagrams for QuestDB SQL guides and cookbooks?

To generate diagrams for QuestDB SQL guides and cookbooks, this Skill executes Python scripts to produce visual assets. It integrates diagram generation directly into the documentation creation process for developers.