extensions-site-manager

Document site manager API endpoints and hook generation in Madoc TypeScript services.

57|15|Updated Nov 28, 2018
One-click install
npx skills add https://github.com/digirati-co-uk/madoc-platform --skill extensions-site-manager
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: extensions-site-manager
Source: https://github.com/digirati-co-uk/madoc-platform/tree/main/.agents/skills/extensions-site-manager
Command: npx skills add https://github.com/digirati-co-uk/madoc-platform --skill extensions-site-manager

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The Madoc site manager extension APIs can become inconsistent when changes are made across services, leading to integration errors and broken workflows.

Core Features & Use Cases

  • API Surface Documentation: Provides a clear overview of endpoints for sites, users, invitations, terms, and badges.
  • Hook Generation Insight: Shows how React Query hooks are derived from API calls.
  • Consistency Checks: Helps ensure updates to extensions maintain type safety and query behavior.

Quick Start

Use the extensions-site-manager skill to review and align the site manager API definitions across the Madoc TypeScript services.

Frequently Asked Questions about extensions-site-manager

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

FAQPage Schema
How do I document Madoc site manager API endpoints for TypeScript services?

To document Madoc site manager API endpoints, review and align the definitions across services/madoc-ts to ensure consistency for sites, users, invitations, terms, and badges. This process standardizes API signatures and type definitions.

What is the best way to keep Madoc extension API signatures consistent?

The best way to keep Madoc extension API signatures consistent is by reviewing and aligning the type definitions and query behavior across the TypeScript services. This prevents integration errors and broken workflows when extending site management endpoints.

How does React Query hook generation work for Madoc site manager extensions?

React Query hook generation for Madoc site manager extensions works by deriving hooks directly from the defined API calls. Reviewing the API surface shows how these hooks are generated and ensures type safety and query behavior are maintained.

Why do Madoc site manager APIs become inconsistent across services?

Madoc site manager APIs become inconsistent when changes are made across services without aligning extensions, leading to integration errors. Reviewing and updating the TypeScript service definitions ensures API signatures remain consistent.

Can I use this approach to manage user and invitation endpoints in Madoc?

Yes, you can manage user and invitation endpoints in Madoc by applying consistency checks to the site manager extension API surface. This covers sites, users, invitations, terms, and badges to ensure type safety across services.

What are the limitations of manually updating Madoc TypeScript services API surfaces?

Manually updating Madoc TypeScript services API surfaces risks breaking workflows and causing integration errors due to overlooked inconsistencies. Without alignment, type definitions and React Query hook generation may fail to match.