skills.rest
zabiny
zabinyOFFICIAL
Explore all skills by this author →
WebsiteGitHub

developer-manual-maintainer

Sync Klabis developer documentation with current codebase API signatures.

2|2|Updated Sep 20, 2023
Search Tags:#documentation#refactoring#openspec#api-reference#code-sync#developer-manual
One-click install
npx skills add https://github.com/zabiny/klabis --skill developer-manual-maintainer
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: developer-manual-maintainer
Source: https://github.com/zabiny/klabis/tree/main/.claude/skills/developer-manual-maintainer
Command: npx skills add https://github.com/zabiny/klabis --skill developer-manual-maintainer

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and assets (resource) components.

What problem does it solve?

This skill keeps Klabis developer documentation in sync with the codebase, ensuring the docs accurately reflect the current API and framework conventions.

Core Features & Use Cases

  • Keeps the docs aligned with changes in common framework blocks and framework-like sections (ActingUser, OAuth2 customization).
  • Proposes structure refinements, reads source files to extract signatures, updates index, cross-links, and navigation, and validates HTML conventions.
  • Use Case: after a major refactor in common or members modules, it refreshes the developer manual to reflect new APIs and patterns.

Quick Start

Sync docs/developerManual with the current codebase to update the manual and API references.

Frequently Asked Questions about developer-manual-maintainer

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

FAQPage Schema
How do I keep developer documentation in sync with codebase refactoring?▼

Keeping developer documentation in sync with codebase refactoring requires reading updated source signatures and applying source guidance to refresh HTML structure, cross-links, and navigation in the developer manual.

What is the best way to update API references after changing framework blocks?▼

Updating API references after changing framework blocks involves reading the latest source signatures from common modules like ActingUser or OAuth2 customization and enforcing consistency with the codebase and HTML conventions.

How does syncing API documentation with source files work?▼

Syncing API documentation with source files works by reading the current codebase signatures, proposing structure refinements, and updating index pages and cross-links to ensure the developer manual accurately reflects the current API.

When do I need to regenerate developer manual HTML structure?▼

You need to regenerate developer manual HTML structure after a major refactor in common or members modules, ensuring new APIs, framework patterns, and navigation are accurately reflected and validated against HTML conventions.

Can I use this to update cross-links and navigation for OAuth2 customization patterns?▼

Yes, you can update cross-links and navigation for OAuth2 customization patterns by reading the modified source files, extracting the new signatures, and refreshing the developer manual to maintain consistency with the codebase.

Does updating developer documentation require validating HTML conventions?▼

Yes, updating developer documentation requires validating HTML conventions to ensure that newly extracted source signatures, index structures, and cross-links maintain structural consistency during larger refactors.

Related Skills

Explore More Software Engineering Skills→
sancovpsancovp

doc-mirror-seework

Synchronize codebase documentation with source code changes via a state machine.

Community
Advanced
EsellersEGEsellersEG

shopify-dev

Search Shopify developer documentation for API definitions and implementation examples.

Community
Intermediate
obraobra
41

Gardening Skills Wiki

Validate wiki links, naming, frontmatter, and INDEX coverage via garden.sh.

Community
Intermediate
Andreicr1Andreicr1

api-documentation

Generate HTML, Markdown, and PDF API documentation from OpenAPI specs or code comments.

Community
Advanced