update-user-docs

Analyze git diffs and pull request metadata to synchronize user-facing documentation.

44|7|Updated Oct 16, 2024

Search Tags:#automation #documentation #markdown #github #developer-experience #nextra

Ready to run

npx skills add https://github.com/DiscourseGraphs/discourse-graph --skill update-user-docs

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: update-user-docs
Source: https://github.com/DiscourseGraphs/discourse-graph/tree/main/skills/update-user-docs
Command: npx skills add https://github.com/DiscourseGraphs/discourse-graph --skill update-user-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill eliminates the manual overhead of keeping user-facing documentation in sync with code changes, ensuring that new features or behavior modifications are always accurately reflected in the project's knowledge base.

Core Features & Use Cases

Context-Aware Updates: Automatically analyzes git diffs or PR details to determine the scope of documentation changes required.
Platform-Specific Guidance: Enforces strict adherence to project conventions for Obsidian and Roam documentation trees.
Use Case: When a developer ships a new feature, this skill identifies the affected platform, suggests the appropriate documentation file, and ensures the content follows the project's established style and navigation mapping.

Quick Start

Use the update-user-docs skill to generate documentation for the changes in the current branch.

Frequently Asked Questions about update-user-docs

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

FAQPage Schema

How do I automate documentation updates for feature releases?▼

To automate documentation updates for feature releases, you can use a skill that analyzes git diffs and pull request metadata to synchronize user-facing markdown files with codebase changes. It ensures structural and stylistic consistency across your content tree.

How do I keep Nextra documentation in sync with code changes?▼

Keeping Nextra documentation in sync with code changes requires analyzing git diffs to identify required content updates. The automation operates within the Nextra-based content tree to enforce platform-specific structural and stylistic conventions.

How does automatic documentation generation from pull requests work?▼

Automatic documentation generation from pull requests works by analyzing PR metadata and git diffs to determine the scope of changes. It then validates documentation against defined file path heuristics and suggests appropriate content updates.

Can I enforce authoring conventions for Obsidian and Roam documentation?▼

Yes, you can enforce authoring conventions for Obsidian and Roam documentation by validating documentation scope against project-specific rules. The automation ensures content follows established styles and navigation mapping for these platforms.

What is the best way to maintain markdown documentation accuracy during developer releases?▼

The best way to maintain markdown documentation accuracy during developer releases is to automate synchronization between code and content. This eliminates manual overhead by analyzing diffs to ensure new features are accurately reflected.

What are the limitations of using file path heuristics for documentation automation?▼

Limitations of using file path heuristics for documentation automation include strict validation boundaries for scope. If code changes fall outside defined path heuristics, the automation may not identify the affected documentation files for updates.