mr-details-document

Generate MR/PR detail documents and store them in the project vault.

Updated Aug 27, 2026

Search Tags:#architecture #code-review #pull-request #decision-history #mr-documentation #vault-storage

Ready to run

npx skills add https://github.com/BearyDevs/dotfiles --skill mr-details-document

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: mr-details-document
Source: https://github.com/BearyDevs/dotfiles/tree/main/.config/opencode/skills/mr-details-document
Command: npx skills add https://github.com/BearyDevs/dotfiles --skill mr-details-document

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Traditional MR documentation is time-consuming and often lacks structure. This skill generates a comprehensive MR/PR detail document and stores it in the project's vault, clarifying architecture, decisions, and impact for reviewers.

Core Features & Use Cases

Generates a complete MR/PR detail document describing architecture, decisions, and impact.
Stores the document in the project's vault under vaults/{ProjectName}/mr/{branch-name}.md (branch name converted to filename).
Helps reviewers understand the changes without reading every line of code.

Quick Start

Trigger the MR details process for your current branch to generate a comprehensive vault document.

Frequently Asked Questions about mr-details-document

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

FAQPage Schema

How do I document merge request architecture and decisions for reviewers?▼

Merge request documentation is generated as a comprehensive detail document covering architecture, decisions, and impact, then stored in the project vault under vaults/{ProjectName}/mr/{branch-name}.md for reviewers to access.

What should be included in pull request documentation besides code diffs?▼

Pull request documentation should focus on why and what changed rather than code diffs, specifically detailing architecture decisions and impact to help reviewers understand modifications without reading every line of code.

When do I need to generate an MR detail document?▼

An MR detail document is needed when a feature branch is complete, when reviewers request a summary of changes, or when documenting architecture, decisions, and impact for a merge request.

How are branch names handled when storing MR documents in vault storage?▼

Branch names are converted to filenames when storing MR documents in vault storage, placing the generated markdown file under the structured path vaults/{ProjectName}/mr/{branch-name}.md within the project.

Can I use vault storage to summarize code review changes for a feature branch?▼

Yes, vault storage is used to store a complete MR/PR detail document that summarizes code review changes, applying when a feature branch is complete and reviewers need a structured summary of the modifications.

What are the limitations of generating MR documentation focused on decision history?▼

MR documentation generated this way focuses on why and what changed rather than providing code diffs, meaning reviewers needing line-by-line code analysis must still inspect the pull request diff directly.