doc-edit

Update READMEs, code comments, and markdown/MDX content without altering code logic.

3|1|Updated May 15, 2025
One-click install
npx skills add https://github.com/xergioalex/xergioalex.com --skill doc-edit-xergioalex
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-edit
Source: https://github.com/xergioalex/xergioalex.com/tree/main/.claude/skills/doc-edit
Command: npx skills add https://github.com/xergioalex/xergioalex.com --skill doc-edit-xergioalex

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill streamlines the process of updating and maintaining documentation across various file types, ensuring clarity and consistency without altering code logic.

Core Features & Use Cases

  • Documentation Updates: Modify README files, code comments (JSDoc, inline), and markdown/MDX blog posts.
  • Style Adherence: Follows existing documentation styles and guidelines, ensuring uniformity.
  • Use Case: Update the README.md for a new feature, add inline comments to explain a complex function, or revise a blog post for better clarity.

Quick Start

Update the documentation for the 'user-authentication' feature in the main README file.

Frequently Asked Questions about doc-edit

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

FAQPage Schema
How do I update markdown and MDX documentation without altering code logic?

To update markdown and MDX documentation without altering code logic, you need a tool that isolates content modifications from functional code. This approach ensures style adherence and clarity while strictly preserving the underlying code functionality.

Can I add inline comments and JSDoc to .astro, .svelte, and .ts files automatically?

Yes, you can add inline comments and JSDoc to .astro, .svelte, and .ts files. The process identifies existing code structures and inserts explanatory comments directly within them, ensuring no functional logic modifications are made to the source files.

What is the best way to maintain consistency across README files and code comments?

The best way to maintain consistency across README files and code comments is to apply an automated documentation update process. This enforces existing style guidelines uniformly across all markdown content and inline code comments throughout the project.

Does this documentation update tool support blog posts in markdown and MDX formats?

Yes, this documentation update tool supports blog posts in both markdown and MDX formats. It specifically targets files located in directories like src/content/blog/*.md and src/content/blog/*.mdx to revise content for better clarity.

Will updating documentation files modify my application's functional code?

No, updating documentation files will not modify your application's functional code. The process strictly focuses on English content updates within specified paths like docs/ and src/**/README.md, guaranteeing no code logic modifications occur.