* add libreoffice skill and +29 workflow bundles. * Add documentation for workflow bundles Added comprehensive documentation for workflow bundles, detailing granular and consolidated bundles across various development scenarios including frontend, backend, WordPress, system administration, security testing, AI/ML, cloud/DevOps, database, testing/QA, and LibreOffice skills. * add readme for workflow bundles. correct descriptions of libreoffice skills and match them with folder names. * add readme for workflow bundles. correct descriptions of libreoffice skills and match them with folder names. * Simplify LibreOffice skill names in README * Refactor LibreOffice Base skill to LibreOffice Writer Updated the skill from LibreOffice Base to LibreOffice Writer, modifying the name, description, and core capabilities. Adjusted workflows and examples to reflect document creation and automation. * Rename skill from Writer to Base and update capabilities Updated the LibreOffice skill from Writer to Base, reflecting changes in functionality related to database management and operations. * Revise LibreOffice Calc skill details and capabilities Updated the LibreOffice Calc skill description and removed outdated sections. Streamlined capabilities and workflows while maintaining essential information. * Refine LibreOffice Draw skill details and capabilities Updated the LibreOffice Draw skill description and capabilities. Removed flowchart automation example and adjusted related skills. * Refine SKILL.md for LibreOffice Impress Updated the SKILL.md file for LibreOffice Impress to refine the name and description, streamline core capabilities, and adjust related skills. * Refine LibreOffice Writer skill details and capabilities Updated the LibreOffice Writer skill description and capabilities. Simplified the name and improved clarity in the core capabilities section. * chore: sync generated registry files [ci skip] * feat: add Game Development Expansion Bundle (Bevy ECS, GLSL, Godot 4 Migration) --------- Co-authored-by: Munir Abbasi <munir@ayubmed.edu.pk> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
3.2 KiB
3.2 KiB
name, description, source, risk, domain, category, version
| name | description | source | risk | domain | category | version |
|---|---|---|---|---|---|---|
| api-documentation | API documentation workflow for generating OpenAPI specs, creating developer guides, and maintaining comprehensive API documentation. | personal | safe | documentation | granular-workflow-bundle | 1.0.0 |
API Documentation Workflow
Overview
Specialized workflow for creating comprehensive API documentation including OpenAPI/Swagger specs, developer guides, code examples, and interactive documentation.
When to Use This Workflow
Use this workflow when:
- Creating API documentation
- Generating OpenAPI specs
- Writing developer guides
- Adding code examples
- Setting up API portals
Workflow Phases
Phase 1: API Discovery
Skills to Invoke
api-documenter- API documentationapi-design-principles- API design
Actions
- Inventory endpoints
- Document request/response
- Identify authentication
- Map error codes
- Note rate limits
Copy-Paste Prompts
Use @api-documenter to discover and document API endpoints
Phase 2: OpenAPI Specification
Skills to Invoke
openapi-spec-generation- OpenAPIapi-documenter- API specs
Actions
- Create OpenAPI schema
- Define paths
- Add schemas
- Configure security
- Add examples
Copy-Paste Prompts
Use @openapi-spec-generation to create OpenAPI specification
Phase 3: Developer Guide
Skills to Invoke
api-documentation-generator- Documentationdocumentation-templates- Templates
Actions
- Create getting started
- Write authentication guide
- Document common patterns
- Add troubleshooting
- Create FAQ
Copy-Paste Prompts
Use @api-documentation-generator to create developer guide
Phase 4: Code Examples
Skills to Invoke
api-documenter- Code examplestutorial-engineer- Tutorials
Actions
- Create example requests
- Write SDK examples
- Add curl examples
- Create tutorials
- Test examples
Copy-Paste Prompts
Use @api-documenter to generate code examples
Phase 5: Interactive Docs
Skills to Invoke
api-documenter- Interactive docs
Actions
- Set up Swagger UI
- Configure Redoc
- Add try-it functionality
- Test interactivity
- Deploy docs
Copy-Paste Prompts
Use @api-documenter to set up interactive documentation
Phase 6: Documentation Site
Skills to Invoke
docs-architect- Documentation architecturewiki-page-writer- Documentation
Actions
- Choose platform
- Design structure
- Create pages
- Add navigation
- Configure search
Copy-Paste Prompts
Use @docs-architect to design API documentation site
Phase 7: Maintenance
Skills to Invoke
api-documenter- Doc maintenance
Actions
- Set up auto-generation
- Configure validation
- Add review process
- Schedule updates
- Monitor feedback
Copy-Paste Prompts
Use @api-documenter to set up automated doc generation
Quality Gates
- OpenAPI spec complete
- Developer guide written
- Code examples working
- Interactive docs functional
- Documentation deployed
Related Workflow Bundles
documentation- Documentationapi-development- API developmentdevelopment- Development