doc-from-ticket

Converts MariaDB DOCS Jira tickets into source-verified GitBook documentation edits.

28|115|Updated Jan 28, 2025
One-click install
npx skills add https://github.com/mariadb-corporation/mariadb-docs --skill doc-from-ticket-mariadb-corporation
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-from-ticket
Source: https://github.com/mariadb-corporation/mariadb-docs/tree/main/.claude/skills/doc-from-ticket
Command: npx skills add https://github.com/mariadb-corporation/mariadb-docs --skill doc-from-ticket-mariadb-corporation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Documentation written from Jira ticket prose alone often repeats feature requests or paraphrases that don't match what actually shipped. This Skill turns a MariaDB DOCS ticket into a concrete documentation edit where every factual claim (defaults, syntax, version notes) is verified against the local MariaDB source code before anything is written. ## Core Features & Use Cases - Ticket-to-Source Traceability: Fetches the DOCS ticket via Jira MCP tools, follows it to the upstream MDEV ticket or GitHub PR, and pins the exact commit SHA used for verification. - Mandatory Claim Verification: Checks system variables, SQL grammar, options, and error codes against files like sql/sys_vars.cc and sql/sql_yacc.yy using read-only git grep/show, marking each claim VERIFIED, CORRECTED, or UNVERIFIED. - Guarded Drafting and Paper Trail: Refuses to draft on main/master, locates the correct .md page, drafts GitBook-formatted edits, and writes a fact-check report to an external reports directory for later posting to the ticket. - Use Case: You receive DOCS-1234 asking to document a new InnoDB variable. The Skill fetches the ticket, confirms the variable's default and scope in the server source at a pinned commit, drafts the reference page edit on the DOCS-1234 branch, and leaves a verification report. ## Quick Start Ask the assistant to document DOCS-1234 by verifying its claims against the local MariaDB server source and drafting the GitBook page edit.

Frequently Asked Questions about doc-from-ticket

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

FAQPage Schema
How do I document a MariaDB DOCS Jira ticket?▼

Provide the DOCS ticket key and the Skill fetches it via Jira MCP tools, follows the linked MDEV or GitHub PR, verifies each factual claim against local MariaDB source code, and drafts the GitBook Markdown edit on the ticket's feature branch.

How to verify documentation claims against MariaDB source code?▼

Claims are checked read-only using git grep and git show at a pinned commit SHA against files like sql/sys_vars.cc for variable defaults, sql/sql_yacc.yy for syntax, and errmsg-utf8.txt for error codes. Each claim is marked VERIFIED, CORRECTED, or UNVERIFIED.

Can I draft documentation edits directly on the main branch?▼

No. The Skill refuses to write or draft any page edit when the working tree is on main, master, or a detached HEAD. You must first create a DOCS-XXXX feature branch, typically via the /jira-start command, before drafting.

What happens if a ticket claim cannot be verified against source?▼

Unverifiable claims are never asserted as fact. They are either omitted from the draft or marked with a TODO comment for human confirmation, and recorded as UNVERIFIED rows in the fact-check report.

Does the skill commit or push the documentation changes?▼

No. The Skill only edits files on the current feature branch after user approval. It never runs git add, commit, push, or opens pull requests; committing and Jira transitions remain separate user-driven steps.