doc-agent

Generate Markdown migration, validation, and test reports plus a combined HTML report from pipeline state files.

Updated Apr 4, 2026
One-click install
npx skills add https://github.com/Vikaskanturi/java_to_python_migration_agent --skill doc-agent-vikaskanturi
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-agent
Source: https://github.com/Vikaskanturi/java_to_python_migration_agent/tree/main/skills_extracted/doc-agent
Command: npx skills add https://github.com/Vikaskanturi/java_to_python_migration_agent --skill doc-agent-vikaskanturi

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill automates the creation of human-readable documentation for a Java→Python migration pipeline by reading pipeline state files and producing structured Markdown reports plus a single combined HTML report, saving engineers time and ensuring consistent, reviewable outputs.

Core Features & Use Cases

  • Aggregate pipeline state: reads manifest, migration_state, validation_state, and test_state to derive report content.
  • Produce multiple deliverables: generates migration_report.md, validation_report.md, test_report.md, developer_guide.md, and full_report.html.
  • LLM-powered narrative generation: uses an LLM to write concise Markdown sections and converts them to HTML with an optional markdown library fallback.
  • Use Case: maintainers and migration engineers who need a consolidated migration summary, validation findings, test results, and actionable developer documentation.

Quick Start

Use the doc-agent to generate migration, validation, test, and developer guide documents and produce a combined HTML report from the pipeline state files.

Frequently Asked Questions about doc-agent

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

FAQPage Schema
How do I generate developer guides and HTML reports from Java to Python migration pipeline state files?

You can generate developer guides and HTML reports by feeding your Java to Python migration pipeline state files into an automated agent that reads the manifest, migration, validation, and test states to produce structured Markdown and combined HTML outputs.

What is the best way to automate migration documentation for a Java to Python codebase conversion?

Automating Java to Python migration documentation is best handled by using an LLM-powered agent that aggregates pipeline state files to write concise Markdown sections for migration, validation, and test reports, then converts them into a single HTML file.

Do I need a specific Python markdown package to convert migration reports to HTML?

You do not need a strict specific package, as the conversion uses an optional Python markdown library and includes a safe fallback mechanism to generate the combined HTML report if the package is missing.

Can I produce separate validation and test reports instead of a single combined HTML document?

Yes, the process produces multiple distinct deliverables including separate validation_report.md and test_report.md files, alongside the migration report and developer guide, before combining them into a full HTML report.

What pipeline state inputs are required to create a full migration HTML report?

Creating a full migration HTML report requires access to pipeline state files including the manifest, migration_state, validation_state, and test_state, along with an LLM client to generate the Markdown narrative content.